Skip to content

Commit

Permalink
Merge pull request #9 from axiomhq/arne/experimental-warning
Browse files Browse the repository at this point in the history
Add experimental warning, token details
  • Loading branch information
seiflotfy authored Feb 1, 2023
2 parents b046cf1 + 478f8a3 commit 93c89ed
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# :warning: EXPERIMENTAL :warning:

This is still experimental. Traces are ingested raw into Axiom and there's no nice way to view them (yet).

----

![tracing-axiom: The official Rust tracing layer for Axiom](.github/images/banner-dark.svg#gh-dark-mode-only)
![tracing-axiom: The official Rust tracing layer for Axiom](.github/images/banner-light.svg#gh-light-mode-only)

Expand Down Expand Up @@ -29,7 +35,8 @@ tracing-axiom = "0.3"

If you use the [Axiom CLI](https://github.com/axiomhq/cli), run `eval $(axiom config export -f)` to configure your environment variables.

Otherwise create an API token in [the Axiom settings](https://cloud.axiom.co/settings/profile) and export it as `AXIOM_TOKEN`.
Otherwise create an API token in [the Axiom settings](https://cloud.axiom.co/settings/profile) and export it as `AXIOM_TOKEN`.
The token needs to have ingest permission to all datasets, using it will automatically create a `_traces` dataset for you.

Set up tracing in one line like this:

Expand Down Expand Up @@ -89,4 +96,4 @@ Licensed under either of
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))
- MIT license ([LICENSE-MIT](LICENSE-MIT) or [opensource.org/licenses/MIT](http://opensource.org/licenses/MIT))

at your option.
at your option.

0 comments on commit 93c89ed

Please sign in to comment.