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 "Decorators" resource with the "Get All" operation. This operation retrieves a list of all decorators configured in your Graylog instance. Decorators in Graylog are used to enrich log messages with additional information or formatting.

Common scenarios:

  • Fetching all decorators to audit or review their configuration.
  • Integrating decorator data into automated workflows for monitoring or reporting.
  • Using decorator information as part of a larger log management or alerting process.

Practical example:
You might use this node to periodically export all decorators and store them in a database for compliance tracking, or to trigger alerts if certain decorators are missing or misconfigured.


Properties

Name Type Meaning
Authentication options The authentication method to use (Token Authentication or Basic Authentication).
Additional Fields collection Optional fields such as "Limit" to restrict the number of results returned.
Simplify boolean If enabled, simplifies the output structure for easier downstream processing.
Simplify Path string Specifies a path to a property that should be extracted and returned from the response.

Output

  • The node outputs a json field containing the list of decorators retrieved from Graylog.
  • If Simplify is enabled, the output will be a simplified version of the original API response, potentially extracting only the relevant properties as specified by Simplify Path.
  • The structure typically includes an array of decorator objects, each representing a decorator's configuration and metadata.

Example output (simplified):

[
  {
    "id": "decorator-id",
    "type": "string",
    "config": { /* decorator-specific config */ },
    "order": 1
  },
  ...
]
  • If binary data is ever output (not typical for this operation), it would represent exported files or similar artifacts.

Dependencies

  • External Services: Requires access to a running Graylog instance with API enabled.
  • API Credentials:
    • Token Authentication: Needs a valid Graylog API token.
    • Basic Authentication: Needs a valid username and password.
  • n8n Configuration:
    • Credentials must be set up in n8n under "graylogTokenApi" or "graylogBasicApi".
    • The correct authentication method must be selected in the node properties.

Troubleshooting

Common issues:

  • Invalid credentials:
    Error: "401 Unauthorized" or "Invalid credentials provided."
    Resolution: Check that the correct authentication method and credentials are configured in n8n.

  • Connection errors:
    Error: "ENOTFOUND" or "ECONNREFUSED"
    Resolution: Ensure the Graylog server URL is correct and accessible from the n8n instance.

  • Empty results:
    If no decorators are returned, verify that decorators exist in your Graylog instance and that any applied limit is not set to zero.

  • Incorrect simplify path:
    If using "Simplify Path", ensure the path matches the structure of the Graylog API response; otherwise, the output may be empty or undefined.


Links and References

Discussion