getLogCollectorDetails()

API Stability	`Short-Term`

The getLogCollectorDetails() GraphQL query to get the LogCollector's details. This is a preview, though, and subject to change.

Syntax

Below is the syntax for getLogCollectorDetails():

graphql

getLogCollectorDetails(
      machineId: string!
   ): LogCollectorDetails

Here's an example of how this query field might be used:

Show:

graphql

query {
  getLogCollectorDetails(machineId: "123")
     {id, hostname, ipAddress,
      configurations {id, name, assignment} }
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  getLogCollectorDetails(machineId: \"123\")
     {id, hostname, ipAddress,
      configurations {id, name, assignment} }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  getLogCollectorDetails(machineId: \"123\")
     {id, hostname, ipAddress,
      configurations {id, name, assignment} }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "query { ^
  getLogCollectorDetails(machineId: \"123\") ^
     {id, hostname, ipAddress, ^
      configurations {id, name, assignment} } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  getLogCollectorDetails(machineId: \"123\")
     {id, hostname, ipAddress,
      configurations {id, name, assignment} }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "query {
  getLogCollectorDetails(machineId: \"123\")
     {id, hostname, ipAddress,
      configurations {id, name, assignment} }
}"
}';
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

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "query {
  getLogCollectorDetails(machineId: \"123\")
     {id, hostname, ipAddress,
      configurations {id, name, assignment} }
}"
}'''

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

print(resp.text)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "query {
  getLogCollectorDetails(machineId: \"123\")
     {id, hostname, ipAddress,
      configurations {id, name, assignment} }
}"
}
);


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

Returned Datatypes

For LogCollectorDetails, there are a couple possible values returned, which are listed below.

Table: LogCollectorDetails

Parameter	Type	Required	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: Mar 26, 2025
`configurations`	[`LogCollectorConfigInfo`]	yes	`Short-Term`	The log collector configurations. See `LogCollectorConfigInfo`.
`cpuAverage5Min`	float		`Short-Term`	The CPU average for a five minute period.
`diskMax5Min`	float		`Short-Term`	The disk maximum for a five minute period.
`ephemeralTimeout`	integer		`Short-Term`	The ephemeral timeout in milliseconds.
`errors`	[string]	yes	`Short-Term`	The errors.
`hostname`	string	yes	`Short-Term`	The hostname.
`id`	string	yes	`Short-Term`	The unique identifier of the collector, if enrolled.
`ipAddress`	string		`Short-Term`	The IP address.
`lastActivity`	string	yes	`Short-Term`	The last activity recorded.
`logSources`	`LogCollectorLogSource`	yes	`Short-Term`	The log collector's log source. See `LogCollectorLogSource`.
`machineId`	string	yes	`Short-Term`	The log collector's machine ID.
`memoryMax5Min`	long		`Short-Term`	The maximum memory usage for a five minute period.
`status`	`LogCollectorStatusType`		`Short-Term`	The status of the log collector. See `LogCollectorStatusType`.
`system`	string	yes	`Short-Term`	The host system.
`version`	string	yes	`Short-Term`	The version.

GraphQL Queries

GraphQL API Stability

GraphQL Mutations

GraphQL Datatypes

getLogCollectorDetails()

Syntax

Returned Datatypes

Enter search term