Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

The node interacts with the Dataiku DSS API to perform various operations on different resources within a Dataiku DSS instance. Specifically, for the Job resource and the Get Job Logs operation, it retrieves the logs content of a specified job or one of its activities if specified. This is useful for monitoring job execution, debugging issues, or auditing job runs in Dataiku DSS projects.

Typical use cases include:

  • Fetching logs after running a job to verify success or diagnose failures.
  • Automating log retrieval for scheduled jobs to integrate with external monitoring systems.
  • Extracting logs for compliance or audit purposes.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project containing the job.
Job ID The unique identifier of the job whose logs are to be retrieved.
Query Parameters Optional additional parameters to filter or modify the log retrieval request (e.g., pagination, filters).

Output

The output contains the logs content of the specified job in the json field under the key logs. The logs are returned as a string representing the textual content of the job's execution logs.

If the logs are binary or file-based (not typical for job logs), the node would prepare binary data accordingly, but for this operation, the output is textual logs in JSON format.

Example output structure:

[
  {
    "json": {
      "logs": "Log content text here..."
    }
  }
]

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs valid API credentials including the DSS server URL and a user API key for authentication.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API.
  • No additional external services are required beyond the Dataiku DSS API.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not provided or invalid, the node will throw an error indicating missing credentials. Ensure that the API key and server URL are correctly configured.
  • Required Parameter Missing: The node validates required parameters such as Project Key and Job ID. If these are missing, it throws descriptive errors. Provide all mandatory fields.
  • API Request Failures: Network issues, incorrect URLs, or permission problems can cause API call failures. Check network connectivity, API endpoint correctness, and user permissions in Dataiku DSS.
  • Parsing Errors: If the response from the API is not valid JSON or unexpected, parsing may fail. This could indicate an API change or server issue.
  • Empty Logs: If no logs are found for the given job ID, the output might be empty or contain a "204 No Content" status. Verify the job ID and that the job has generated logs.

Links and References

This summary focuses on the Job resource and the Get Job Logs operation as requested, based on static analysis of the provided source code and input properties.

Discussion