Graylog icon

Graylog

Consume Graylog API (v.1.1.0)

Overview

This n8n node interacts with the Graylog API, specifically targeting the Decorators resource and the Get Available operation. It allows users to retrieve a list of available decorators from their Graylog instance. Decorators in Graylog are used to modify or enrich log messages for better visualization and analysis.

Common scenarios:

  • Fetching all available decorators to display or select within an automation workflow.
  • Integrating decorator information into reporting or alerting processes.
  • Dynamically adapting workflows based on available decorators in Graylog.

Practical example:
A user wants to automate the process of listing all decorators in their Graylog system to ensure that new decorators are detected and logged for audit purposes.


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 available decorators retrieved from Graylog.
  • If Simplify is enabled, the output will be a simplified version of the data, potentially extracting only the property specified by Simplify Path.
  • The exact structure depends on the Graylog API's response for the decorators endpoint, but typically includes details such as decorator IDs, types, configurations, and descriptions.

Dependencies

  • Graylog Instance: Requires access to a running Graylog server with API enabled.
  • API Credentials:
    • For Token Authentication: A valid Graylog API token.
    • For Basic Authentication: Valid username and password credentials.
  • n8n Configuration: Credentials must be set up in n8n under either "graylogTokenApi" or "graylogBasicApi".

Troubleshooting

Common Issues:

  • Invalid Credentials:
    Error: "401 Unauthorized" or similar.
    Resolution: Ensure the correct authentication method and valid credentials are provided in n8n.

  • Insufficient Permissions:
    Error: "403 Forbidden".
    Resolution: The authenticated user must have permission to access decorators in Graylog.

  • Incorrect Simplify Path:
    Error: "Cannot read property '...' of undefined" or empty output.
    Resolution: Double-check the path specified in "Simplify Path" matches the structure of the Graylog API response.

  • Network/Connection Errors:
    Error: "ENOTFOUND", "ECONNREFUSED", etc.
    Resolution: Verify network connectivity between n8n and the Graylog server.


Links and References

Discussion