API Stability Preview

The refreshClusterManagementStats() GraphQL mutation may be used to force a refresh of the ClusterManagementStats cache and return reasonsNodeCannotBeSafelyUnregistered for the specified node.

When developing scripts to automate the unregistration of multiple evicted nodes at a time, this mutation can be called to validate that the node being unregistered can be terminated without risking data loss. As the mutation is expensive, it should not be called frequently.

Syntax

graphql
refreshClusterManagementStats(
      nodeId: integer!
   ): RefreshClusterManagementStatsMutation!

There is no special input datatype for this mutation field.

Example

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  refreshClusterManagementStats( nodeId: 3 )
    { reasonsNodeCannotBeSafelyUnregistered { isAlive, hasUnderReplicatedData } }
}
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 {
  refreshClusterManagementStats( nodeId: 3 )
    { reasonsNodeCannotBeSafelyUnregistered { isAlive, hasUnderReplicatedData } }
}"
}
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 {
  refreshClusterManagementStats( nodeId: 3 )
    { reasonsNodeCannotBeSafelyUnregistered { isAlive, hasUnderReplicatedData } }
}"
}
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 { ^
  refreshClusterManagementStats( nodeId: 3 ) ^
    { reasonsNodeCannotBeSafelyUnregistered { isAlive, hasUnderReplicatedData } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  refreshClusterManagementStats( nodeId: 3 )
    { reasonsNodeCannotBeSafelyUnregistered { isAlive, hasUnderReplicatedData } }
}"
}'
    "$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 {
  refreshClusterManagementStats( nodeId: 3 )
    { reasonsNodeCannotBeSafelyUnregistered { isAlive, hasUnderReplicatedData } }
}";
$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 {
  refreshClusterManagementStats( nodeId: 3 )
    { reasonsNodeCannotBeSafelyUnregistered { isAlive, hasUnderReplicatedData } }
}"
}'''

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 {
  refreshClusterManagementStats( nodeId: 3 )
    { reasonsNodeCannotBeSafelyUnregistered { isAlive, hasUnderReplicatedData } }
}"
}
);


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();

Returned Datatype

With this returned datatype, you can determine if a node is alive, if it has data that no other node have, and other data regarding whether a node cannot be safely unregistered. The table below has a link to another table with these sub-parameters and more:

Table: RefreshClusterManagementStatsMutation

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 23, 2024
reasonsNodeCannotBeSafelyUnregisteredReasonsNodeCannotBeSafelyUnregisteredyes PreviewThe reasons the node cannot be safely unregistered. See ReasonsNodeCannotBeSafelyUnregistered.