acryl-executor 0.3.16

An library used within Acryl Agents to execute tasks

Acryl Executor

Remote execution agent used for running DataHub tasks, such as ingestion powered through the UI.

python3 -m venv --upgrade-deps venv
source venv/bin/activate
pip3 install .

Notes

By default, this library comes with a set of default task implementations:

RUN_INGEST Task

• SubprocessProcessIngestionTask - Executes a metadata ingestion run by spinning off a subprocess. Supports ingesting from a particular version, and with a specific plugin (based on the platform type requested)

• InMemoryIngestionTask - Executes a metadata ingestion run using the datahub library in the same process. Not great for production where we can see strange dependency conflicts when certain packages are executed together. Use this for testing, as it has no ability to check out a specific DataHub Metadata Ingestion plugin.

Cloud Logging (S3)

There is one implementation of a cloud logging client that writes logs to S3. This is used by the Acryl Executor to write logs to S3. To enable it you should set the following environment variables: ENV DATAHUB_CLOUD_LOG_BUCKET - The S3 bucket to write logs to ENV DATAHUB_CLOUD_LOG_PATH - The S3 path to write logs to

The logs are compressed with tar and gzipped before being uploaded to S3 to the following path: s3://CLOUD_LOG_BUCKET/CLOUD_LOG_PATH/<pipeline_id>/year=/month=/day=/<run_id>/

Local file cleanup after upload

When S3 upload is enabled, local log and artifact files can optionally be removed after a successful upload and replaced by a <filename>.s3 sentinel file containing:

{
  "s3_uri": "s3://bucket/path/executor-logs/executor-logs.tgz",
  "uploaded_at": "2024-01-15T10:30:00.000000+00:00",
  "original_size_bytes": 1234567
}

To enable cleanup, set DATAHUB_CLOUD_LOG_CLEANUP=true. Cleanup only takes effect when DATAHUB_CLOUD_LOG_BUCKET is set (no bucket → no upload → no cleanup) and only after each individual archive upload succeeds. A failed upload leaves the original file untouched.

Note: DATAHUB_CLOUD_LOG_CLEANUP requires DATAHUB_CLOUD_LOG_BUCKET to be set.