Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/agardnerit/helm-trace

Helm Plugin to generate OpenTelemetry traces for helm commands
https://github.com/agardnerit/helm-trace

helm helm-plugin

Last synced: 27 days ago
JSON representation

Helm Plugin to generate OpenTelemetry traces for helm commands

Host: GitHub
URL: https://github.com/agardnerit/helm-trace
Owner: agardnerIT
License: apache-2.0
Created: 2023-08-03T22:27:15.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-08-15T01:17:55.000Z (over 1 year ago)
Last Synced: 2023-08-15T03:44:06.341Z (over 1 year ago)
Topics: helm, helm-plugin
Language: Shell
Homepage:
Size: 140 KB
Stars: 2
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Helm Plugin to Generate OpenTelemetry Traces

[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/helm-trace)](https://artifacthub.io/packages/search?repo=helm-trace)

Helm Plugin to generate OpenTelemetry traces for helm commands.

```
helm trace
```

![helm trace install](assets/helm-trace-install.png)

### YouTube: Helm Trace Code Walkthrough

[Watch on YouTube](https://youtu.be/Zjq3NTEydkI?t=478)

[![helm trace plugin on YouTube](https://img.youtube.com/vi/Zjq3NTEydkI/0.jpg)](https://www.youtube.com/watch?v=Zjq3NTEydkI&t=478)

## Prerequisites
- Currently only supports Linux and MacOS
- You must have [a standalone binary of tracepusher in your path](https://github.com/agardnerIT/tracepusher/releases/latest) (ie. you are able to run `tracepusher` from the command line and see output)
- You must have an OpenTelemetry collector somewhere so the spans can be sent there

## Install Plugin

```
helm plugin install https://github.com/agardnerit/helm-trace
```

## Use the Plugin

1. Ensure you have an OpenTelemetry Collector available
2. Add the word `trace` after `helm` in your standard command. For example `helm version` becomes `helm trace version`

## Defaults and Configuration

The plugin assumes the following:

- The OTEL collector URL defaults to `http://localhost:4318`
- The span service name defaults to `helm`

Use environment variable: `HT_OTELCOL_ENDPOINT` to specify your collector endpoint

Use environment variable: `HT_SERVICE_NAME` to specify a different service name

```
export HT_OTEL_ENDPOINT=http://otelcol.somewhere.com:4318
export HT_OTEL_ENDPOINT=helm-dev
helm trace install ...
```

## Remove Plugin

```
helm plugin remove trace
```