Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API to perform various administrative and operational tasks on a Dataiku DSS instance. Specifically, for the DSS Administration resource and the Get Log operation, it retrieves the content of a specified log file from the DSS server.

Common scenarios where this node is beneficial include:

  • Monitoring and troubleshooting DSS system behavior by fetching logs such as web server logs, notebook logs, or core backend platform logs.
  • Automating log retrieval for audit or compliance purposes.
  • Integrating DSS logs into broader monitoring or alerting workflows.

Example use case:

  • Automatically fetch the "webserver" log file after a scheduled job run to analyze errors or warnings.

Properties

Name Meaning
Name The name of the log file to retrieve from the DSS administration logs. This should correspond to one of the available log files on the DSS instance (e.g., "webserver", "notebook", "core").

Output

The output contains the retrieved log data in the json field under the key corresponding to the log content.

  • If the log content is JSON-formatted, it will be parsed and returned as a JSON object.
  • If the log content is plain text, it will be returned as a string in the json output.
  • The node does not output binary data for this operation.

Output example (JSON):

{
  "logContent": {
    "timestamp": "2024-06-01T12:00:00Z",
    "level": "INFO",
    "message": "Service started successfully"
  }
}

Or if plain text:

{
  "logContent": "2024-06-01 12:00:00 INFO Service started successfully\n..."
}

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials with sufficient permissions to access DSS administration logs.
  • The node expects the DSS server URL and an API key credential to authenticate requests.
  • No additional external dependencies beyond the standard n8n environment and the Dataiku DSS API.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that the API key credential for the DSS instance is configured correctly in n8n.
  • Name Parameter Required: The "Name" property must be provided; otherwise, the node will throw an error indicating the missing log name.
  • HTTP Errors: If the DSS server URL is incorrect or unreachable, or if the API key lacks permission, the node will return an error. Verify network connectivity and API key permissions.
  • Parsing Errors: If the log content is not valid JSON but the node attempts to parse it, it will fallback to returning raw text. This is expected behavior.

Links and References


This summary focuses exclusively on the DSS Administration resource and the Get Log operation as requested.

Discussion