The setOldObjectSampleEnabled() GraphQL mutation is used to toggle the OldObjectSample event on and off.

To set the duration of the old object sample, use the setOldObjectSampleDurationMinutes() mutation. Related to these mutations, there is the flightRecorderSettings() query to get the Java Flight Recorder settings. There's also the resetFlightRecorderSettings() query to reset the flight recorder settings to the default.

API Stability Preview

Syntax

graphql
setOldObjectSampleEnabled(
      vhost: integer!,
      oldObjectSampleEnabled: boolean!
   ): boolean

For the input, you'll have to give the node to change, and indicate whether to enable the old object sample event. See the Given Datatype for details.

There are no return parameters to specify. It returns true if successful.

Example

Raw
graphql
mutation {
  setOldObjectSampleEnabled(
     vhost: 2,
     oldObjectSampleEnabled: true
  )
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  setOldObjectSampleEnabled(
     vhost: 2,
     oldObjectSampleEnabled: true
  )
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  setOldObjectSampleEnabled(
     vhost: 2,
     oldObjectSampleEnabled: true
  )
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  setOldObjectSampleEnabled( ^
     vhost: 2, ^
     oldObjectSampleEnabled: true ^
  ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  setOldObjectSampleEnabled(
     vhost: 2,
     oldObjectSampleEnabled: true
  )
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  setOldObjectSampleEnabled(
     vhost: 2,
     oldObjectSampleEnabled: true
  )
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  setOldObjectSampleEnabled(
     vhost: 2,
     oldObjectSampleEnabled: true
  )
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  setOldObjectSampleEnabled(
     vhost: 2,
     oldObjectSampleEnabled: true
  )
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "setOldObjectSampleEnabled": true
  }
}

Given Datatype

For the input, you'll have to give the node to change, and indicate whether to enable the old object sample event.

Table: Input Using Standard Datatypes

Parameter Type Required Default Description
oldObjectSampleEnabled boolean yes   Whether to enable the old object sample event.
vhost integer yes   The node for which to change the setting.