Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nadment/hop-opentelemetry

Apache Hop OpenTelemetry plugins to send traces to monitor the execution of workflows/actions/pipelines.
https://github.com/nadment/hop-opentelemetry

apache-hop opentelemetry

Last synced: 4 months ago
JSON representation

Apache Hop OpenTelemetry plugins to send traces to monitor the execution of workflows/actions/pipelines.

Awesome Lists containing this project

README 

        
////

Licensed to the Apache Software Foundation (ASF) under one

or more contributor license agreements.  See the NOTICE file

distributed with this work for additional information

regarding copyright ownership.  The ASF licenses this file

to you under the Apache License, Version 2.0 (the

"License"); you may not use this file except in compliance

with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,

software distributed under the License is distributed on an

"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

KIND, either express or implied.  See the License for the

specific language governing permissions and limitations

under the License.

////

# Hop OpenTelemetry Plugin

:url-sonarcloud: https://sonarcloud.io/dashboard?id=hop-opentelemetry



image:https://sonarcloud.io/api/project_badges/measure?project=hop-opentelemetry&metric=alert_status[Sonarcloud,link={url-sonarcloud}]

image:https://sonarcloud.io/api/project_badges/measure?project=hop-opentelemetry&metric=coverage[Sonarcloud,link={url-sonarcloud}]



## Overview



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



It uses https://opentelemetry.io[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



https://hop.apache.org[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



[cols="<1,<1", options="header"]

|===

|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.



[cols="<1,<1,<1,<1", options="header"]

|===

|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 https://www.apache.org/licenses/LICENSE-2.0[Apache License, Version 2.0].