Summary

The setOldObjectSampleDurationMinutes() mutation sets the sampling window duration for the Java Flight Recorder's OldObjectSample event on a specific node. When the duration expires, the node flushes accumulated heap-allocation data and restarts the sampling cycle. The OldObjectSample event tracks long-lived object allocations and helps identify memory leaks and allocation patterns. To enable or disable the event instead, use setOldObjectSampleEnabled().

API Stability Short-Term

Syntax

graphql
setOldObjectSampleDurationMinutes(
      vhost: Int!,
      oldObjectSampleDurationMinutes: Long!
   ): Long!

The mutation requires two arguments: vhost identifies the node to configure, and oldObjectSampleDurationMinutes specifies the sampling window length in minutes. The mutation returns the configured duration as a non-null Long! value.

Example

Raw
graphql
mutation {
  setOldObjectSampleDurationMinutes(
     vhost: 2,
     oldObjectSampleDurationMinutes: 1
  )
}
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 {
  setOldObjectSampleDurationMinutes(
     vhost: 2,
     oldObjectSampleDurationMinutes: 1
  )
}"
}
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 {
  setOldObjectSampleDurationMinutes(
     vhost: 2,
     oldObjectSampleDurationMinutes: 1
  )
}"
}
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 { ^
  setOldObjectSampleDurationMinutes( ^
     vhost: 2, ^
     oldObjectSampleDurationMinutes: 1 ^
  ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  setOldObjectSampleDurationMinutes(
     vhost: 2,
     oldObjectSampleDurationMinutes: 1
  )
}"
}'
    "$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 {
  setOldObjectSampleDurationMinutes(
     vhost: 2,
     oldObjectSampleDurationMinutes: 1
  )
}";
$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 {
  setOldObjectSampleDurationMinutes(
     vhost: 2,
     oldObjectSampleDurationMinutes: 1
  )
}"
}'''

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 {
  setOldObjectSampleDurationMinutes(
     vhost: 2,
     oldObjectSampleDurationMinutes: 1
  )
}"
}
);


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": {
    "setOldObjectSampleDurationMinutes": 1
  }
}

Input Parameters

Both parameters are required. Provide the target node identifier and the sampling window duration in minutes.

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
oldObjectSampleDurationMinutes Long yes   The number of minutes that old object sampling runs before flushing accumulated heap-allocation data and restarting the cycle. Shorter values increase sampling frequency but add overhead. Longer values reduce overhead but produce coarser data.
vhost Int yes   The numeric identifier of the node for which to configure the sampling duration.