Skip to content

OtelKit is a powerful and user-friendly CLI tool designed to simplify working with OpenTelemetry.

Notifications You must be signed in to change notification settings

twomatches/OtelKit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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:
    git clone https://github.com/yourusername/otelkit.git
    cd otelkit
  2. Build the CLI tool:
    go build -o otelkit
  3. Move the binary to a directory in your PATH:
    mv otelkit /usr/local/bin/
  4. Verify installation:
    otelkit --help

Usage

Validate Configuration

otelkit validate --schema schema.json --target otel-config.json

View Help

otelkit --help

Author

Your Name
GitHub: @endalk200

About

OtelKit is a powerful and user-friendly CLI tool designed to simplify working with OpenTelemetry.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages