Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nwiizo authored Jan 31, 2024
1 parent f6358fe commit c5cbc23
Showing 1 changed file with 36 additions and 2 deletions.
38 changes: 36 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,36 @@
# tmcurl
T(race)M(eter)curl: A CLI tool for tracing and timing HTTP requests with OpenTelemetry 🌐. It accurately measures response times πŸ•’, supports repetitive requests for performance analysis, and customizes tracing endpoints. Ideal for API testing and monitoring πŸ‘¨β€πŸ’»πŸ”.
# tmcurl πŸš€

`tmcurl` is a CLI tool that traces HTTP requests and measures response times, leveraging the power of OpenTelemetry 🌐. It provides insightful performance data for your HTTP requests.

## Features 🌟

- Trace HTTP requests with OpenTelemetry. πŸ•΅οΈβ€β™‚οΈ
- Measure response times. ⏱
- Customize request methods, headers, and body. πŸ› 
- Execute requests multiple times. πŸ”
- Configure OTLP exporter endpoint. πŸ“‘

## Installation πŸ“¦

`tmcurl` is written in Go. Ensure you have Go installed and then run the following command:

```sh
go get github.com/nwiizo/tmcurl
```

## Usage πŸš€

Use the `tmcurl` command to send and trace HTTP requests:

```sh
tmcurl trace --url "https://3-shake.com" --method "GET"
```

### Options πŸŽ›

- `--endpoint` (string): The OTLP exporter endpoint (default: "localhost:4317").
- `--url` (string): The URL for the HTTP request.
- `--method` (string): The HTTP method to use (default: "GET").
- `--header` (string array): HTTP request headers.
- `--body` (string): The HTTP request body.
- `--count` (int): The number of times to send the request (default: 1).

0 comments on commit c5cbc23

Please sign in to comment.