Graylog icon

Graylog

Consume Graylog API (v.1.1.0)

Overview

The Graylog node for n8n allows you to interact with the Graylog API, specifically targeting the "Metadata" resource and its "Posted Search" operation. This node is useful for automating workflows that require searching or retrieving metadata from a Graylog instance. Common scenarios include integrating log search results into automated monitoring, alerting systems, or data pipelines.

Practical examples:

  • Automatically fetch metadata about posted searches in Graylog for reporting.
  • Integrate Graylog search results into dashboards or notification systems.
  • Enrich incident response workflows with detailed search metadata from Graylog.

Properties

Name Type Meaning
Authentication options The authentication method to use (Token Authentication or Basic Authentication).
Id string The unique identifier for the metadata search.
Simplify boolean Whether to simplify the output structure for easier downstream processing.
Additional Fields collection Optional additional parameters for the search, such as custom fields and their properties.
Simplify Path string Path to the property that should be returned if simplification is enabled.

Output

  • The node outputs a json object containing the results of the posted search metadata request from Graylog.
  • If the Simplify option is enabled, the output may be flattened or reduced according to the specified Simplify Path.
  • The exact structure of the output depends on the Graylog API's response for the posted search metadata endpoint.
  • Binary Data: This node does not output binary data; all output is in JSON format.

Dependencies

  • External Services: Requires access to a running Graylog instance with API enabled.
  • API Credentials:
    • For Token Authentication: Requires a valid Graylog API token (graylogTokenApi credential).
    • For Basic Authentication: Requires Graylog username and password (graylogBasicApi credential).
  • n8n Configuration: Ensure the appropriate credentials are set up in n8n under the node's credential options.

Troubleshooting

  • Authentication Errors:

    • Error Message: "Invalid credentials" or "401 Unauthorized"
    • Resolution: Check that the correct authentication method is selected and the credentials are valid and active in Graylog.
  • Missing Required Field:

    • Error Message: "Id is required"
    • Resolution: Ensure the "Id" field is filled with a valid search identifier.
  • API Connection Issues:

    • Error Message: "Could not connect to Graylog API"
    • Resolution: Verify network connectivity to the Graylog server and that the API endpoint is accessible.
  • Unexpected Output Structure:

    • Issue: Output does not match expectations when "Simplify" or "Simplify Path" is used.
    • Resolution: Double-check the path provided in "Simplify Path" and review the Graylog API documentation for the expected response structure.

Links and References

Discussion