Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API
Join our community

Actions364

Overview

This node integrates with the Dataiku DSS API to perform various operations on internal metrics and other resources within a Dataiku DSS instance. Specifically, for the "Internal Metric" resource with the "List Internal Metrics" operation, it retrieves internal metrics from the DSS instance as a dictionary.

Common scenarios where this node is beneficial include:

  • Monitoring and analyzing internal performance or usage metrics of a Dataiku DSS instance.
  • Automating the retrieval of internal metrics for reporting or alerting purposes.
  • Integrating DSS internal metrics into broader workflows or dashboards.

Example use case:

  • A data engineer wants to periodically fetch internal metrics from their DSS instance to monitor system health and trigger alerts if certain thresholds are exceeded.

Properties

Name Meaning
Query Parameters Collection of optional parameters to filter or modify the request when listing metrics. Options include: Active (boolean), Activity (string), All Users (boolean), Archive Path (string), Catalog Name (string), Code Env Name (string), Column Name (string), Columns (string), Connected (boolean), Connection Name (string), Container Execution Configuration Name (string), Deletion Mode (string), Destination ID (string), Drop Data (boolean), Export Analysis Models (boolean), Export Managed (boolean), Export Saved Models (boolean), Export Uploads (boolean), File Part (string), Filter (string), Folder ID (string), Folder Reference (string), Force Rebuild Env (boolean), Foreign (boolean), Format (string), Format Params (string), Full Class Name (string), Full Reguess (boolean), Include All Partitions (boolean), Include Libs (boolean), Limit (number, min 1, default 50), Max Dataset Count (number), Metric Lookup (string), Min Timestamp (number), Name (string), Only Monitored (boolean), Page (number), Partition (string), Partitions (string), Path (string), Peek (boolean), Prediction Type (string), Project Folder ID (string), Project Key (string), Published Project Key (string), Published Service ID (string), Purpose (string), Remote (string), Remove Intermediate (boolean), Reassign To (string), Results per Page (number), Rule ID (string), Schema Name (string), Step ID (string), Sub-Folder Name (string), Tags (string), Target Variable (string), Time Series Identifiers (string), Time Variable (string), Trigger ID (string), Trigger Run ID (string), Trust For Everybody (boolean), Type (string), Versions (string), Wait (boolean), With Scenarios (boolean).

Note: The full list of query parameter options is extensive; users can specify any combination relevant to filtering or modifying the internal metrics request.

Output

The node outputs the response from the Dataiku DSS API call in the json field of the output items.

  • For the "List Internal Metrics" operation, the output JSON contains a dictionary of internal metrics retrieved from the DSS instance.
  • The structure of the returned JSON depends on the DSS API but generally includes metric names and their corresponding values or details.
  • No binary data output is expected for this operation.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key credential) for authentication with the DSS API.
  • The node uses HTTP requests to communicate with the DSS REST API endpoints.
  • No additional external services or environment variables are required beyond the configured DSS API credentials.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that the Dataiku DSS API credentials are properly configured and provided.
  • Required Parameter Errors: The node validates required parameters based on the selected resource and operation. For example, the project key might be required for some operations. Ensure all mandatory fields are filled.
  • API Request Failures: Network issues, incorrect server URLs, or invalid API keys can cause request failures. Verify the DSS server URL and API key correctness.
  • Unexpected Response Format: If the API returns unexpected data or errors, check the DSS API documentation for changes or restrictions on the requested operation.
  • Large Result Sets: When retrieving many metrics, consider using pagination parameters like limit and page to manage response size.

Links and References

This summary focuses on the "Internal Metric" resource and the "List Internal Metrics" operation as requested.

Discussion