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 performing the "Given Search" operation. This node is useful for retrieving metadata associated with a specific search in your Graylog instance. Common scenarios include automating log analysis workflows, integrating Graylog search results into other systems, or extracting specific metadata fields for reporting or alerting.

Practical examples:

  • Fetching metadata about a saved search by its ID for further processing.
  • Integrating Graylog search metadata into dashboards or notification systems.
  • Automating compliance checks by extracting and simplifying relevant metadata fields.

Properties

Name Type Meaning
Authentication options The authentication method to use (Token Authentication or Basic Authentication).
Search Id string The unique identifier of the search whose metadata you want to retrieve.
Simplify boolean Whether to simplify the output structure.
Simplify Path string (Optional) Path to the property that should be returned if simplification is enabled.

Output

  • The node outputs a json field containing the metadata for the specified search.
  • If Simplify is enabled, the output may be reduced to only the property specified by Simplify Path, or otherwise simplified according to internal logic.
  • The exact structure of the output depends on the Graylog API response and the simplification settings, but typically includes metadata fields related to the search.

Dependencies

  • Graylog API: Requires access to a running Graylog instance with API enabled.
  • API Credentials:
    • Token Authentication: Requires a valid Graylog API token.
    • Basic Authentication: Requires a valid username and password.
  • n8n Credentials: You must configure either "graylogTokenApi" or "graylogBasicApi" credentials in n8n, depending on the selected authentication method.

Troubleshooting

  • Invalid Credentials: If authentication fails, ensure that the correct credentials are configured in n8n and have sufficient permissions.
  • Search Not Found: If the provided Search Id does not exist, the node may return an error or empty result. Double-check the Search Id value.
  • Simplify Path Issues: If an invalid path is provided in "Simplify Path", the output may be empty or throw an error. Ensure the path matches the structure of the metadata object.
  • Network/Connection Errors: Make sure n8n can reach your Graylog instance and that any required firewalls or proxies are properly configured.

Links and References

Discussion