Skip to content

Commit

Permalink
update docs for HAR to OTEL
Browse files Browse the repository at this point in the history
Signed-off-by: Adam Gardner <[email protected]>
  • Loading branch information
agardnerIT committed Jan 7, 2024
1 parent d088197 commit 6b6c530
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ If you like tracepusher and want to do the same thing with logs, check out [logp

# 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)
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Want to do a similar thing with logs? Check out [logpusher](https://agardnerit.g

## Uses

- [DevTools .har file to OpenTelemetry Converter](usage/har-to-otel.md)
- [Trace Kubernetes Jobs and CronJobs with OpenTelemetry](usage/k8sjobs.md)
- [Trace CICD Pipelines with OpenTelemetry](https://github.com/agardnerIT/tracepusher/blob/main/samples/gitlab/README.md)
- [Trace shell scripts with OpenTelemetry](https://github.com/agardnerIT/tracepusher/blob/main/samples/script.sh)
Expand Down
32 changes: 32 additions & 0 deletions docs/usage/har-to-otel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Chrome DevTools HAR File to OpenTelemetry Converter

This tool converts a `.har` file to OpenTelemetry traces and sends them to an OpenTelemetry collector using tracepusher.

## Feedback Required!

If you use this, please provide feedback (good or bad) on [this issue](https://github.com/agardnerIT/tracepusher/issues/72).

When the tool is confirmed as stable, standalone binaries will be built.

## Usage

```
docker run \
--mount type=bind,source="$(pwd)",target=/files \
gardnera/har-to-otel:dev \
-f /files/YOUR-HAR-FILE.har \
-ep http://host.docker.internal:4318 \
--insecure true
```

### Optional flags

If set, these are added as span attributes:

- `--timings [true|false]` (defaults to `true`)
- `--request-headers [true|false]` (defaults to `false`)
- `--response-headers [true|false]` (defaults to `false`)
- `--request-cookies [true|false]` (defaults to `false`)
- `--response-cookies [true|false]` (defaults to `false`)
- `--debug [true|false]` (defaults to `false`)
- `--dry-run [true|false]` (defaults to `false`)
6 changes: 6 additions & 0 deletions docs/usage/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,9 @@ Useful for running CI pipelines in container images.
### Python

[Run tracepusher as a Python script](python.md).

### HAR File to OpenTelemetry Converter

This utility takes a `.har` file (HTTP Archive) as input, converts to OpenTelemetry and sends to the collector.

Go here for the [HAR file to OpenTelemetry converter](har-to-otel.md)

0 comments on commit 6b6c530

Please sign in to comment.