The
addToLogCollectorConfigurationTest()
GraphQL mutation may be used to add to a Log Collector configuration
test. This is a preview and subject to change.
For more information on Log Collector configuration and testing, see
the Configure Falcon LogScale Collector documentation page.
Below is the syntax for the
addToLogCollectorConfigurationTest()
mutation field:
addToLogCollectorConfigurationTest(
configId : string! ,
collectorIds : [ string! ] !
) : FleetConfigurationTest!
Below is an example of how this mutation field might be used:
Show:
Raw Mac OS or Linux (curl) Mac OS or Linux (curl) One-line Windows Cmd and curl Windows Powershell and curl Perl Python Node.js
Raw mutation {
addToLogCollectorConfigurationTest( configId : "1234" , collectorIds : [ "123" , "456" ] )
{ configId, collectorIds}
}
Mac OS or Linux (curl) curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d @- << EOF
{"query" : "mutation {
addToLogCollectorConfigurationTest(configId: \"1234\", collectorIds: [\"123\", \"456\"])
{configId, collectorIds}
}"
}
EOF
Mac OS or Linux (curl) One-line curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d @- << EOF
{"query" : "mutation {
addToLogCollectorConfigurationTest(configId: \"1234\", collectorIds: [\"123\", \"456\"])
{configId, collectorIds}
}"
}
EOF
Windows Cmd and curl curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
-H "Authorization: Bearer $TOKEN" ^
-H "Content-Type: application/json" ^
-d @'{"query" : "mutation { ^
addToLogCollectorConfigurationTest(configId: \"1234\", collectorIds: [\"123\", \"456\"]) ^
{configId, collectorIds} ^
}" ^
} '
Windows Powershell and curl curl.exe -X POST
-H "Authorization: Bearer $TOKEN "
-H "Content-Type: application/json"
-d '{"query" : "mutation {
addToLogCollectorConfigurationTest(configId: \"1234\", collectorIds: [\"123\", \"456\"])
{configId, collectorIds}
}"
}'
"$YOUR_LOGSCALE_URL /graphql"
Perl
use HTTP::Request;
use LWP;
my $INGEST_TOKEN = "TOKEN" ;
my $uri = '$YOUR_LOGSCALE_URL/graphql' ;
my $json = '{"query" : "mutation {
addToLogCollectorConfigurationTest(configId: \"1234\", collectorIds: [\"123\", \"456\"])
{configId, collectorIds}
}"
}' ;
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
import requests
url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
addToLogCollectorConfigurationTest(configId: \"1234\", collectorIds: [\"123\", \"456\"])
{configId, collectorIds}
}"
}'''
resp = requests.post(url,
data = mydata,
headers = {
"Authorization" : "Bearer $TOKEN" ,
"Content-Type" : "application/json"
}
)
print (resp.text)
Node.js const https = require ('https' );
const data = JSON .stringify (
{"query" : "mutation {
addToLogCollectorConfigurationTest(configId: \"1234\", collectorIds: [\"123\", \"456\"])
{configId, collectorIds}
}"
}
);
const options = {
hostname : '$YOUR_LOGSCALE_URL/graphql' ,
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 ();
As indicated by the syntax above, this mutation will return data
using the datatype,
FleetConfigurationTest
.
Below is a list of the parameters of that datatype:
Table: FleetConfigurationTest
Parameter Type Required Default Stability Description Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column. Table last updated: Sep 25, 2024 configId
string yes Short-Term
The configuration identifier. collectorIds
[string] yes Short-Term
The Log Collector unique identifiers.