Skip to content

Latest commit

 

History

History
96 lines (76 loc) · 3.83 KB

README.adoc

File metadata and controls

96 lines (76 loc) · 3.83 KB
Raw

Hop OpenTelemetry Plugin

Sonarcloud Sonarcloud

Overview

This plugin exports distributed telemetry data for analysis, currently sending traces to monitor the execution of workflows/actions/pipelines.

It uses OpenTelemetry, an open source observability framework for generating, processing and transmitting telemetry data in a single, unified format.

OpenTelemetry Metrics and Logging are not yet correctly supported.

How to install

System Requirements

Apache Hop 2.9 or above.

Manual Install

  1. Unzip the plugin archive into the hop\plugins\ directory

  2. Configure OpenTelemetry manually by setting the system variables below or using the GUI perspective configuration tab.

    • OTEL_SERVICE_NAME: Specify logical service name.

    • OTEL_EXPORTER_OTLP_ENDPOINT: Specify target URL of the OpenTelemetry Collector to which send data.

    • OTEL_EXPORTER_OTLP_PROTOCOL: Specify the OTLP transport protocol to be used (grpc or http/protobuf).

    • OTEL_EXPORTER_OTLP_HEADERS: Key-value pairs to be used as headers associated with requests. The format is a list of key-value pairs separated by the "=" character (i.e.: key1=value1,key2=value2)

    • OTEL_EXPORTER_OTLP_TIMEOUT: Default timeout is 10 seconds

  3. Restart Hop

Usage

Trace attributes

Name Description

host.name

The name or IP address of the host.

service.name

The name of the service.

service.version

The version of the service.

hop.runtime

The name of the Hop tool running (GUI, Server,…​).

hop.project

hop.environment

hop.workflow.engine

hop.workflow.run_configuration

hop.workflow.execution_id

hop.workflow.container_id

hop.workflow.file.path

hop.workflow.version

hop.action.plugin_id

hop.pipeline.engine

hop.pipeline.run_configuration

hop.pipeline.execution_id

hop.pipeline.container_id

hop.pipeline.file.path

hop.pipeline.version

hop.transform.plugin_id

Metrics catalog

The table below provides a list of metrics provided by this plugin.

Name Description Type Attributes

workflow.execution.count

The total number of times a workflow has been executed.

counter

hop.workflow.engine

action.execution.count

The total number of times an action has been executed.

counter

hop.action.plugin_id

pipeline.execution.count

The total number of times a pipeline has been executed.

counter

hop.pipeline.engine

transform.execution.count

The total number of times a transform has been executed.

counter

hop.transform.plugin_id

Support

This plugin is provided as is, without any warranties, expressed or implied. This software is not covered by any Support Agreement.

License

Licensed under the Apache License, Version 2.0.