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
descriptionstring  A description of the Log Collector configuration.
draftstring  The configuration draft.
draftModifiedAtdatetimeyes The date and time of the last draft of the configuration.
idstringyes The unique identifier for the log collector configuration.
instancesintegeryes The number of instances.
isTestRunningbooleanyes Whether a test is running.
modifiedAtdatetimeyes The date and time of the current configuration.
modifiedBystringyes Who last modified the configuration.
namestringyes The name assigned to the log collector configuration.
versionintegeryes The version used.
yamlstring  Configuration in YAML format.
yamlCharactersCountintegeryes The YAML character count.

[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.