The logCollectorConfiguration() GraphQL query returns the configuration for a Log Collector.

Syntax

Below is the syntax for the logCollectorConfiguration() query field:

graphql
logCollectorConfiguration(
     id: string!
   ): LogCollectorConfiguration

Returned Datatypes

The returned datatype LogCollectorConfiguration has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: LogCollectorConfiguration

ParameterTypeRequired[a]DefaultDescription
idstringyes The unique identifier for the log collector configuration.
namestringyes The name assigned to the log collector configuration.
yamlstring  Configuration in YAML format.
draftstring  The configuration draft.
versionintegeryes The version used.
yamlCharactersCountintegeryes The YAML character count.
modifiedAtdatetimeyes The date and time of the current configuration.
draftModifiedAtdatetimeyes The date and time of the last draft of the configuration.
modifiedBystringyes Who last modified the configuration.
instancesintegeryes The number of instances.
descriptionstring  A description of the Log Collector configuration.
isTestRunningbooleanyes Whether a test is running.
filterstring  Any filter used.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.