API Stability Long-Term

The addToLogCollectorConfigurationTest() GraphQL mutation may be used to add to a Log Collector configuration test.

To start a Log Collector configuration test, use the startLogCollectorConfigurationTest() mutation. To stop a test, use the stopLogCollectorConfigurationTest() mutation. You can use removeFromLogCollectorConfigurationTest() to remove a test.

Hide Query Example

Show Test Running Query

For more information on Log Collector configuration and testing, see the Configure Falcon LogScale Collector documentation page.

Syntax

graphql
addToLogCollectorConfigurationTest(
      configId: string!,
      collectorIds: [string]!
   ): FleetConfigurationTest!

Example

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

Raw
graphql
mutation {
  addToLogCollectorConfigurationTest(
     configId: "cfg1", 
     collectorIds: ["abc123", "def456"] )
  { configId, collectorIds }
}
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 {
  addToLogCollectorConfigurationTest(
     configId: \"cfg1\", 
     collectorIds: [\"abc123\", \"def456\"] )
  { configId, collectorIds }
}"
}
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 {
  addToLogCollectorConfigurationTest(
     configId: \"cfg1\", 
     collectorIds: [\"abc123\", \"def456\"] )
  { configId, collectorIds }
}"
}
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 { ^
  addToLogCollectorConfigurationTest( ^
     configId: \"cfg1\",  ^
     collectorIds: [\"abc123\", \"def456\"] ) ^
  { configId, collectorIds } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  addToLogCollectorConfigurationTest(
     configId: \"cfg1\", 
     collectorIds: [\"abc123\", \"def456\"] )
  { configId, collectorIds }
}"
}'
    "$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 {
  addToLogCollectorConfigurationTest(
     configId: \"cfg1\", 
     collectorIds: [\"abc123\", \"def456\"] )
  { configId, collectorIds }
}";
$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 {
  addToLogCollectorConfigurationTest(
     configId: \"cfg1\", 
     collectorIds: [\"abc123\", \"def456\"] )
  { configId, collectorIds }
}"
}'''

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 {
  addToLogCollectorConfigurationTest(
     configId: \"cfg1\", 
     collectorIds: [\"abc123\", \"def456\"] )
  { configId, collectorIds }
}"
}
);


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": {
    "addToLogCollectorConfigurationTest": {
      "configId": "cfg1",
      "collectorIds": [ "abc123", "def456"]
    }
  }
}

Returned Datatype

For this returned datatype, you can get a list of LogCollector IDs in case you want to remove some or add more. Below is a list of the parameters to get this information:

Table: FleetConfigurationTest

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 25, 2024
configIdstringyes Short-TermThe configuration identifier.
collectorIds[string]yes Short-TermThe Log Collector unique identifiers.