https://github.com/twomatches/otelkit
OtelKit is a powerful and user-friendly CLI tool designed to simplify working with OpenTelemetry.
https://github.com/twomatches/otelkit
cli open-telemetry opentelemetry-kit otelkit
Last synced: 4 days ago
JSON representation
OtelKit is a powerful and user-friendly CLI tool designed to simplify working with OpenTelemetry.
- Host: GitHub
- URL: https://github.com/twomatches/otelkit
- Owner: twomatches
- Created: 2024-11-28T11:00:44.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-12-07T08:30:18.000Z (10 months ago)
- Last Synced: 2025-04-03T06:51:10.759Z (6 months ago)
- Topics: cli, open-telemetry, opentelemetry-kit, otelkit
- Language: Go
- Homepage:
- Size: 15.6 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OtelKit
**OtelKit** is a powerful and user-friendly CLI tool designed to simplify working with OpenTelemetry. Whether you're validating configurations, generating boilerplate, or performing advanced utilities, OtelKit is here to make integrating OpenTelemetry into your applications effortless.
## Description
OpenTelemetry is a complex ecosystem, and setting it up correctly can be daunting. OtelKit aims to ease this process by providing a set of utilities to:
- Validate OpenTelemetry configurations to ensure correctness and adherence to best practices.
- Generate OpenTelemetry boilerplate for new projects, saving time and effort.
- Offer additional features to streamline tracing, logging, and telemetry integration.
With OtelKit, developers and operators can focus more on building features and less on telemetry setup.
## Features
- **Configuration Validator**: Validate your OpenTelemetry configuration files to catch errors early.
- **Boilerplate Generator**: Quickly generate boilerplate code for OpenTelemetry in Go projects.
- **CLI Commands**: Intuitive commands and options for various OpenTelemetry tasks.
- **Extensible**: More features to come in future releases, including integrations for tracing, metrics, and logging.
## Getting Started
### Prerequisites
- Go 1.20 or later installed.
- Basic understanding of OpenTelemetry concepts.
### Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/otelkit.git
cd otelkit
```
2. Build the CLI tool:
```bash
go build -o otelkit
```
3. Move the binary to a directory in your PATH:
```bash
mv otelkit /usr/local/bin/
```
4. Verify installation:
```bash
otelkit --help
```
### Usage
#### Validate Configuration
```bash
otelkit validate --schema schema.json --target otel-config.json
```
#### View Help
```bash
otelkit --help
```
## Author
**Your Name**
GitHub: [@endalk200](https://github.com/endalk200)