Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/agardnerit/tracepusher
Generate and push OpenTelemetry Trace data to an OTEL collector in JSON format
https://github.com/agardnerit/tracepusher
opentelemetry python
Last synced: 8 days ago
JSON representation
Generate and push OpenTelemetry Trace data to an OTEL collector in JSON format
- Host: GitHub
- URL: https://github.com/agardnerit/tracepusher
- Owner: agardnerIT
- License: apache-2.0
- Created: 2023-02-16T07:30:09.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-21T10:45:50.000Z (4 months ago)
- Last Synced: 2024-08-21T12:13:14.770Z (4 months ago)
- Topics: opentelemetry, python
- Language: Python
- Homepage:
- Size: 90.8 MB
- Stars: 52
- Watchers: 5
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenTelemetry tracepusher
> OpenTelemetry traces for every usecase.
## [> View the tracepusher documentation <](https://agardnerit.github.io/tracepusher)
Generate and push OpenTelemetry Trace data to an endpoint in JSON format.
# Watch: tracepusher in Action
[YouTube: tracepusher tracing a GitLab pipeline](https://www.youtube.com/watch?v=zZDFQNHepyI).
If you like tracepusher and want to do the same thing with logs, check out [logpusher](https://agardnerit.github.io/logpusher).
# Uses
- [.har file to OpenTelemetry Converter](https://agardnerit.github.io/tracepusher/usage/har-to-otel)
- [Trace Kubernetes Jobs and Cronjobs with OpenTelemetry](https://agardnerit.github.io/tracepusher/usage/k8sjobs/)
- [Trace CICD Pipelines with OpenTelemetry](samples/gitlab/README.md)
- [Trace shell scripts with OpenTelemetry](samples/script.sh)
- [Trace Helm with OpenTelemetry](https://github.com/agardnerit/helm-trace)
- 🆕 [Tracking GitHub Codespace creation with OpenTelemetry](samples/github_codespaces/creation_log_parser.py)
- Trace anything with OpenTelemetry!
# Try In Browser
See [try tracepusher in-browser without installation](https://agardnerit.github.io/tracepusher/try/).
## Standalone Binary
See [download and use tracepusher as a standalone binary](https://agardnerit.github.io/tracepusher/usage/standalone.md)
## Python3 Usage
See [use tracepusher as a Python script](https://agardnerit.github.io/tracepusher/usage/python).
## Docker Usage
See [use tracepusher as a docker image](https://agardnerit.github.io/tracepusher/usage/docker/).
## CI Usage
See [run a CI pipeline step as a docker image with tracepusher](https://agardnerit.github.io/tracepusher/usage/ci).
## Dry Run Mode
See [dry run mode flag](https://agardnerit.github.io/tracepusher/reference/dry-run-mode/).
## Debug Mode
See [debug mode flag](https://agardnerit.github.io/tracepusher/reference/debug-mode/).
## Time Shifting
See [time shifting](https://agardnerit.github.io/tracepusher/reference/time-shifting/).
## Complex Tracing (Sub Span support)
See [multi-span traces](https://agardnerit.github.io/tracepusher/reference/multi-span-traces/).
## Span Attributes
> Only supported with `v0.6.0` and above.
See [span attribute types](https://agardnerit.github.io/tracepusher/reference/span-attribute-types/).
## Span Events
> Only supported with `v0.7.0` and above.
See [span events](https://agardnerit.github.io/tracepusher/reference/span-events/).
## Span Kind
> Only supported with `v0.8.0` and above.
See [span kind](https://agardnerit.github.io/tracepusher/reference/span-kind/)
## Span Duration and Duration Type
> Only supported with `v0.8.0` and above.
tracepusher will generate spans of `n` seconds.
This behaviour can be overridden by using the `--duration-type` parameter.
See [duration type](https://agardnerit.github.io/tracepusher/reference/duration-type/) page.
## Span Status
> Only supported with `v0.9.0` and above.
tracepusher users can set the status of the span (`OK`, `ERROR` or `UNSET`).
Default is `OK`.
See [span status](https://agardnerit.github.io/tracepusher/reference/span-status) page.
## Insecure flag
> Only supported with `v0.9.0` and above.
tracepusher users can set `--insecure [false|true]` to allow sending spans to `http://` vs. `https://` endpoints.
Defaults to `false` but behaviour differs by version.
See [insecure flag](https://agardnerit.github.io/tracepusher/reference/insecure-flag) for more info.
## Start Time
> Only supported with `v0.10.0` and above.
tracepusher users can (optionally) set the span start time using the `--start-time` flag. If unset, defaults to `now`.
See [start time flag](https://agardnerit.github.io/tracepusher/reference/start-time-flag) for more info.
## Spin up OpenTelemetry Collector
See [OpenTelemetry Collector configuration](https://agardnerit.github.io/tracepusher/reference/otel-col)
# Adopters
Do you use tracepusher? Thanks and we'd love to know!
Submit a PR and add your details to [ADOPTERS.md](ADOPTERS.md)
# FAQs
See [FAQ](https://agardnerit.github.io/tracepusher/faq).
# Breaking Changes
See [Breaking changes](https://agardnerit.github.io/tracepusher/breaking-changes)
# Building Standalone Binaries
Note: PyInstaller is platform dependent. You must build on whatever platform you wish to run tracepusher on.
When tracepusher is released, the [build_standalone_binaries.yml workflow](.github/workflows/build_standalone_binaries.yml) completes this step and uploads the resulting binaries to S3 where we (currently manually) attach each generated binary to the release notes.
```
python -m PyInstaller --onefile tracepusher.py
```
# Building Docker Image
Run all build commands from the root directory:
```
docker buildx build --platform linux/arm64,linux/amd64 --push -t tracepusher:dev-ci -f ./docker/ci/Dockerfile .
docker buildx build --platform linux/arm64,linux/amd64 --push -t tracepusher:dev -f ./docker/standard/Dockerfile .
```
# Install Requirements
For Non-Developers
```
pip install -r requirements.txt
```
For Developers
```
pip install -r requirements-dev.txt
```
# Testing
Run the test suite:
```
pytest
```
----------------------
# Contributing
All contributions are most welcome!
Get involved:
- Tackle a [good first issue](https://github.com/agardnerIT/tracepusher/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
- Create an issue to suggest something new
- File a PR to fix something
Made with [contrib.rocks](https://contrib.rocks).