The createLogCollectorConfiguration() mutation creates a named Log Collector configuration in LogScale. A configuration holds the YAML settings that control how a Log Collector instance ingests and forwards data. Newly created configurations are inactive — they do not affect any Log Collector instance until you assign the configuration with assignLogCollectorConfiguration() and publish it with publishLogCollectorConfiguration().

You can optionally supply a draft at creation time using the draft argument. The draft is a staging area separate from the active published YAML. If you omit draft, the configuration is created with no content; add content later with updateDraftLogCollectorConfiguration(). Retrieve the id from the response — all subsequent mutations that modify or assign this configuration require it.

To update the draft content after creation, use updateDraftLogCollectorConfiguration(). To assign a Log Collector configuration to an instance, use assignLogCollectorConfiguration(). To publish a draft and make it the active configuration, use publishLogCollectorConfiguration(). To rename a configuration, use updateLogCollectorConfigurationName(). To update the description of a configuration, use updateLogCollectorConfigurationDescription(). To delete a configuration, use deleteLogCollectorConfiguration().

To run a configuration test against assigned Log Collector instances, use startLogCollectorConfigurationTest(). Use addToLogCollectorConfigurationTest() and removeFromLogCollectorConfigurationTest() to manage which instances participate, and stopLogCollectorConfigurationTest() to end the test.

To retrieve a specific configuration by ID, use the logCollectorConfiguration() query. To search configurations by name or other criteria, use searchLogCollectorConfigurations().

For information on Log Collector, see the Falcon LogScale Collector pages in the main documentation. See the Configure Falcon LogScale Collector section for details on configuring.

createLogCollectorConfiguration(
      name: String!, draft: String
   ): LogCollectorConfiguration!

The name argument is required and sets the human-readable identifier for the configuration. This name appears in the LogScale UI and in API responses that list configurations. The optional draft argument supplies initial YAML content conforming to the Log Collector configuration schema. Draft content is separate from the active published YAML; it does not affect running Log Collector instances until you call publishLogCollectorConfiguration().

The mutation returns a non-null LogCollectorConfiguration object. On a newly created configuration, yaml is null because no version has been published yet. Request id to obtain the configuration identifier required by subsequent mutations.

Provide a unique name for the new configuration. Optionally, provide initial YAML draft content to populate the staging area at creation time.

The mutation returns a LogCollectorConfiguration object representing the newly created configuration. Always request id — all subsequent mutations that modify, assign, or delete this configuration require it.

The version field is an integer counter that starts at 0 on a new configuration and increments with each call to publishLogCollectorConfiguration(). Store this value and pass it as currentVersion in that mutation to enforce optimistic concurrency control: the publish fails if another caller has updated the configuration since you last read it.

The yaml field is null on a newly created configuration because no version has been published yet; it contains the active published YAML only after the first call to publishLogCollectorConfiguration(). The yamlCharactersCount field reflects the character count of that published YAML, and is 0 until a version is published. The draft field holds the YAML content passed in the draft argument, or null if you omitted it; the draftModifiedAt field records when the draft was last modified, or null if no draft has been set.

The instances field is 0 on a newly created configuration; it increments as Log Collector instances are assigned with assignLogCollectorConfiguration(). The isTestRunning field is false on a new configuration; it becomes true when a configuration test is started with startLogCollectorConfigurationTest(). The description field is null at creation time; set it after creation with updateLogCollectorConfigurationDescription(). The modifiedAt and modifiedBy fields record when the configuration was created and by which user.