Configure task log collection and exporting to ElasticSearch

Configure how Astronomer exports task logs to your ElasticSearch instance.

Airflow task logs are stored in a logging backend to ensure you can access them after your Pods terminate. By default, Astronomer uses Vector to collect task logs and export them to an ElasticSearch instance.

You can configure how Astronomer collects Deployment task logs and exports them to ElasticSearch. The following are the supported methods for exporting task logs to ElasticSearch:

• Using a Daemonset pod on each Kubernetes node in your cluster.
• Using container sidecars for Deployment components.

Export task logs using a Vector DaemonSet

Exporting task logs using a Vector Daemonset is not supported for Airflow 3.

By default, Astro Private Cloud uses a Vector DaemonSet to aggregate task logs. This is the workflow for the default implementation:

• Deployments write task logs to stdout.
• Kubernetes takes the output from stdout and writes it to the Deployment’s node.
• A Vector Pod reads logs from the node and forwards them to ElasticSearch.

Astronomer recommends using Vector Daemonset for Organizations that:

• Run longer tasks using Celery executor.
• Run Astro Private Cloud in a dedicated cluster.
• Run privileged containers in a cluster with a ClusterRole.

This approach is not suited for Organizations that don’t allow logging container to run in privileged mode and run many small tasks using the Kubernetes executor. Because task logs exist only for the lifetime of the Pod, your Pods running small tasks might complete before Vector can collect their task logs.

Export logs using container sidecars

You can use a logging sidecar container to collect and export logs. In this implementation:

• Each container running an Airflow component for a Deployment receives its own Vector sidecar.
• Task logs are written to a shared directory.
• The Vector sidecar reads logs from the shared directory and writes them to ElasticSearch.

This implementation is recommended for organizations that:

• Run Astro Private Cloud in a multi-tenant cluster, where security is a concern.
• Use the KubernetesExecutor to run many short-lived tasks, which requires improved reliability.

Configure logging sidecars

1. Retrieve your values.yaml file. See Apply a config change.

2. Add the following entry to your values.yaml file:

   global:
     vectorEnabled: false
     loggingSidecar:
       enabled: true
       name: sidecar-log-consumer
   
   If you’re migrating from Fluentd, you must also set the following configuration so that Astro Private Cloud can retain logs:

   global:
     logging:
       indexNamePrefix: <your-index-prefix>
   

3. Push the configuration change. See Apply a config change.

Customize Vector logging sidecars

You can customize the default Astronomer Vector logging sidecar to have different transformations and sinks based on your team’s requirements. This is useful if you want to annotate, customize, or filter your logs before sending them to your logging platform.

1. In the Astro UI, go to your Clusters page and select your cluster.

2. In the cluster details, click Edit in the Deployment Configuration section and add the override below in the Configuration Override field:

   global:
     loggingSidecar:
       enabled: true
       name: sidecar-log-consumer
       customConfig: true
   

   For more info on using the Configuration Override in the UI, see Override base configuration.

3. Save and apply your changes in the UI.

Pushing this change updates the configuration for the Cluster. Individual deployments will receive the new sidecar logging configuration once they are redeployed.

3. Create a custom vector configuration yaml file to change how and where sidecars forward your logs. The following examples are template configurations for each commonly used external logging service. For the complete default logging sidecar configmap, see the Astronomer GitHub.

Elasticsearch

log_schema:
  timestamp_key : "@timestamp"
data_dir: "${SIDECAR_LOGS}"
sources:
  airflow_log_files:
    type: file
    include:
      - "${SIDECAR_LOGS}/*.log"
    read_from: beginning
transforms:
  transform_airflow_logs:
    type: remap
    inputs:
      - airflow_log_files
    source: |
      .component = "${COMPONENT:--}"
      .workspace = "${WORKSPACE:--}"
      .release = "${RELEASE:--}"
      .date_nano = parse_timestamp!(.@timestamp, format: "%Y-%m-%dT%H:%M:%S.%f%Z")

  filter_common_logs:
    type: filter
    inputs:
      - transform_airflow_logs
    condition:
      type: "vrl"
      source: '!includes(["worker","scheduler"], .component)'

  filter_scheduler_logs:
    type: filter
    inputs:
      - transform_airflow_logs
    condition:
      type: "vrl"
      source: 'includes(["scheduler"], .component)'

  filter_worker_logs:
    type: filter
    inputs:
      - transform_airflow_logs
    condition:
      type: "vrl"
      source: 'includes(["worker"], .component)'

  filter_gitsyncrelay_logs:
    type: filter
    inputs:
      - transform_airflow_logs
    condition:
      type: "vrl"
      source: 'includes(["git-sync-relay"], .component)'

  transform_task_log:
    type: remap
    inputs:
      - filter_worker_logs
      - filter_scheduler_logs
    source: |-
      . = parse_json(.message) ?? .
      .@timestamp = parse_timestamp(.timestamp, "%Y-%m-%dT%H:%M:%S%Z") ?? now()
      .check_log_id = exists(.log_id)
      if .check_log_id != true {
      .log_id = join!([to_string!(.dag_id), to_string!(.task_id), to_string!(.execution_date), to_string!(.try_number)], "_")
      }
      .offset = to_int(now()) * 1000000000 + to_unix_timestamp(now()) * 1000000

  final_task_log:
    type: remap
    inputs:
      - transform_task_log
    source: |
      .component = "${COMPONENT:--}"
      .workspace = "${WORKSPACE:--}"
      .release = "${RELEASE:--}"
      .date_nano = parse_timestamp!(.@timestamp, format: "%Y-%m-%dT%H:%M:%S.%f%Z")

  transform_remove_fields:
    type: remap
    inputs:
      - final_task_log
      - filter_common_logs
      - filter_gitsyncrelay_logs
    source: |
      del(.host)
      del(.file)
# Configuration for ElasticSearch sink.
sinks:
  out:
    type: elasticsearch
    # Specify the transforms you want to run before your logs are exported.
    inputs:
      - transform_remove_fields
    mode: bulk
    compression: none
    endpoint: "http://example-host:<example-port>"
    auth:
      strategy: "basic"
      user: "example-user"
      password : "example-pass"
    bulk:
      index: "vector.${RELEASE:--}.%Y.%m.%d"
      action: create

Honeycomb

log_schema:
  timestamp_key : "@timestamp"
data_dir: "${SIDECAR_LOGS}"
sources:
  airflow_log_files:
    type: file
    include:
      - "${SIDECAR_LOGS}/*.log"
    read_from: beginning
transforms:
  transform_syslog:
    type: add_fields
    inputs:
      - generate_syslog
    fields:
      component: "${COMPONENT:--}"
      workspace: "${WORKSPACE:--}"
      release: "${RELEASE:--}"
  transform_task_log:
    type: remap
    inputs:
      - transform_syslog
    source: |-
      # Parse Syslog input. The "!" means that the script should abort on error.
      . = parse_json!(.message)
      .@timestamp = parse_timestamp(.timestamp, "%Y-%m-%dT%H:%M:%S%Z") ?? now()
      .check_log_id = exists(.log_id)
      if .check_log_id != true {
      .log_id = join!([.dag_id, .task_id, .execution_date, .try_number], "_")
      }
      .offset = to_int(now()) * 1000000000 + to_unix_timestamp(now()) * 1000000
# Configuration for Datadog sinks
sinks:
  my_sink_id:
    type: datadog_logs
    # Specify the transforms you want to run before your logs are exported.
    inputs:
      - transform_task_log
    site: us1.datadoghq.com
    default_api_key: <your-api-key>
    encoding:
      codec: json

Datadog

log_schema:
  timestamp_key : "@timestamp"
data_dir: "${SIDECAR_LOGS}"
sources:
  airflow_log_files:
    type: file
    include:
      - "${SIDECAR_LOGS}/*.log"
    read_from: beginning
transforms:
  transform_syslog:
    type: add_fields
    inputs:
      - generate_syslog
    fields:
      component: "${COMPONENT:--}"
      workspace: "${WORKSPACE:--}"
      release: "${RELEASE:--}"
# Configuration for Honeycomb sinks
sinks:
  my_sink_id:
    type: honeycomb
    # Specify the transforms you want to run before your logs are exported.
    inputs:
      - transform_syslog
    api_key: <your-api-key>
    dataset: my-honeycomb-dataset

4. Run the following command to add the configuration file to your cluster as a Kubernetes secret:

   kubectl create secret generic sidecar-config --from-file=vector-values.yaml=vector-values.yaml
   

5. Run the following command to annotate the secret so that it’s automatically applied to all new Deployments:

   kubectl annotate secret secret-name astronomer.io/commander-sync="platform-release=astronomer"
   

6. Run the following command to sync existing Deployments with the new configuration:

   kubectl create job --from=cronjob/astronomer-config-syncer sync-secrets -n astronomer
   

Use an external Elasticsearch instance for Airflow task log management

Add Airflow task logs from your Astronomer Deployment to an existing Elasticsearch instance on Elastic Cloud to centralize log management and analysis. Centralized log management allows you to quickly identify, troubleshoot, and resolve task failure issues. Although these examples use Elastic Cloud, you can also use AWS Managed OpenSearch Service or any other elastic service (managed or hosted). With an external Elasticsearch instance configured for Astro Private Cloud, you can see the logs in your Elasticsearch instance and browse the logs from the Astro Private Cloud UI.

If you use an existing Elasticsearch instance, make sure that the index template is configured to enable auto creation of new indices.

Create an Elastic Deployment and endpoint

1. In your browser, go to https://cloud.elastic.co/ and create a new Elastic Cloud deployment. See Create a deployment.

2. Copy and save your Elastic Cloud deployment credentials when the Save the deployment credentials screen appears.

3. On the Elastic dashboard, click the Gear icon for your Deployment.

4. Click Copy endpoint next to Elasticsearch.

5. (Optional) Test the Elastic Cloud deployment endpoint:

   • Open a new browser window, paste the endpoint you copied in step 4 in the Address bar, and then press Enter.
   • Enter the username and password you copied in step 2 and click Sign in. Output similar to the following appears:
       name	"instance-0000000000"
       cluster_name	"<cluster-name>"
       cluster_uuid	"<cluster-uuid>"
       version
       number	"8.3.2"
       build_type	"docker"
       build_hash	"8b0b1f23fbebecc3c88e4464319dea8989f374fd"
       build_date	"2022-07-06T15:15:15.901688194Z"
       build_snapshot	false
       lucene_version	"9.2.0"
       minimum_wire_compatibility_version	"7.17.0"
       minimum_index_compatibility_version	"7.0.0"
       tagline	"You Know, for Search"
   

Save your Elastic Cloud deployment credentials

After you’ve created an Elastic deployment and endpoint, you have two options to store your Elastic deployment credentials. You can store the credentials in your Astro Private Cloud helm values, or for greater security, as a secret in your Astro Private Cloud Kubernetes cluster. For additional information about adding an Astro Private Cloud configuration change, see Apply a config change.

Updating the Elasticsearch host in your data plane values.yaml does not automatically update the cluster configuration database. After you upgrade your data plane Helm release, manually update the Elasticsearch proxy host through the UI:

1. In the Astro UI, go to Clusters and select your cluster.

2. Click Edit to unlock Configuration Override.

3. Add the following to the Configuration Override:

   {
     "helm": {
       "airflow": {
         "elasticsearch": {
           "enabled": true,
           "connection": {
             "host": "<your-elasticsearch-host>",
             "port": 9200
           }
         }
       }
     }
   }
   

4. Click Update cluster to apply your changes.

5. Update each existing Deployment to apply the new Elasticsearch configuration.

For more information, see Override base configuration.

values.yaml

1. Run the following command to base64 encode your Elastic Cloud deployment credentials:

   echo -n "<username>:<password>" | base64

2. Add the following entry to your values.yaml file:

global:
  vectorEnabled: true
  customLogging:
    enabled: true
    scheme: https
    # host endpoint copied from elasticsearch console with https
    # and port number removed.
    host: "<host-URL>"
    port: "9243"
    # encoded credentials from above step 1
    secret: "<encoded credentials>"

3. Add the following entry to your values.yaml file to disable internal logging:

tags:
  logging: false

4. Run the following command to upgrade the Astro Private Cloud release version in the values.yaml file:

helm upgrade -f values.yaml --version=0.27 --namespace=<your-platform-namespace> <your-platform-release-name> astronomer/astronomer

Kubernetes secret

1. Run the following command to create a secret for your Elastic Cloud Deployment credentials in the Kubernetes cluster:

kubectl create secret generic elasticcreds --from-literal elastic=<username>:<password> --namespace=<your-platform-namespace>

2. Add the following entry to your values.yaml file:

global:
  vectorEnabled: true
  customLogging:
    enabled: true
    scheme: https
    # host endpoint copied from elasticsearch console with https
    # and port number removed.
    host: "<host-URL>"
    port: "9243"
    # kubernetes secret containing credentials
    secretName: elasticcreds

3. Add the following entry to your values.yaml file to disable internal logging:

tags:
     logging: false

4. Run the following command to upgrade the Astro Private Cloud release version in the values.yaml file:

helm upgrade -f values.yaml --version=0.27 --namespace=<your-platform-namespace> <your-platform-release-name> astronomer/astronomer

View Airflow task logs in Elastic

1. On the Elastic dashboard in the Elasticsearch Service area, click the Deployment name.

2. Click Menu > Discover. The Create index pattern screen appears.

3. Enter vector.* if you use Vector Sidecar Logging. In the Name field, enter @timestamp in the Timestamp field, and then click Create index pattern.

4. Click Menu > Dashboard to view all of the Airflow task logs for your Deployment on Astronomer.