Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/axiomhq/axiom-rs
Official Rust bindings for the Axiom API
https://github.com/axiomhq/axiom-rs
async axiom client http o11y rust sdk
Last synced: 12 days ago
JSON representation
Official Rust bindings for the Axiom API
- Host: GitHub
- URL: https://github.com/axiomhq/axiom-rs
- Owner: axiomhq
- License: apache-2.0
- Created: 2022-07-05T14:27:50.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-30T10:52:01.000Z (7 months ago)
- Last Synced: 2024-03-15T08:50:31.132Z (4 months ago)
- Topics: async, axiom, client, http, o11y, rust, sdk
- Language: Rust
- Homepage: https://axiom.co
- Size: 264 KB
- Stars: 28
- Watchers: 3
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Lists
- awesome-axiom - Axiom Rust Library - The Rust SDK for Axiom: Manage datasets, ingest and query all data from your Rust project. (Official Libraries / SDKs and Libraries)
README
[](https://docs.rs/axiom-rs/)
[](https://github.com/axiomhq/axiom-rs/actions?query=workflow%3ACI)
[](https://crates.io/crates/axiom-rs)
[](LICENSE-APACHE)
[Axiom](https://axiom.co) unlocks observability at any scale.
- **Ingest with ease, store without limits:** Axiom’s next-generation datastore enables ingesting petabytes of data with ultimate efficiency. Ship logs from Kubernetes, AWS, Azure, Google Cloud, DigitalOcean, Nomad, and others.
- **Query everything, all the time:** Whether DevOps, SecOps, or EverythingOps, query all your data no matter its age. No provisioning, no moving data from cold/archive to “hot”, and no worrying about slow queries. All your data, all. the. time.
- **Powerful dashboards, for continuous observability:** Build dashboards to collect related queries and present information that’s quick and easy to digest for you and your team. Dashboards can be kept private or shared with others, and are the perfect way to bring together data from different sources
For more information check out the [official documentation](https://axiom.co/docs) and our [community Discord](https://axiom.co/discord).
## Quickstart
Add the following to your `Cargo.toml`:
```toml
[dependencies]
axiom-rs = "0.10"
```
If you use the [Axiom CLI](https://github.com/axiomhq/cli), run
`eval $(axiom config export -f)` to configure your environment variables.
Otherwise, create a personal token in
[the Axiom settings](https://cloud.axiom.co/profile) and make note of
the organization ID from the settings page of the organization you want to
access.
Create and use a client like this:
```rust,no_run
use axiom_rs::Client;
use serde_json::json;
#[tokio::main]
async fn main() -> Result<(), Box> {
// Build your client by providing a personal token and an org id:
let client = Client::builder()
.with_token("my-token")
.with_org_id("my-org")
.build()?;
// Alternatively you autoconfigure the client from the environment variables
// AXIOM_TOKEN and AXIOM_ORG_ID:
let client = Client::new()?;
client.datasets().create("my-dataset", "").await?;
client
.ingest(
"my-dataset",
vec![json!({
"foo": "bar",
})],
)
.await?;
let res = client
.query(r#"['my-dataset'] | where foo == "bar" | limit 100"#, None)
.await?;
println!("{:?}", res);
client.datasets().delete("my-dataset").await?;
Ok(())
}
```
For further examples, head over to the [examples](examples) directory.
## Optional Features
The following are a list of
[Cargo features](https://doc.rust-lang.org/stable/cargo/reference/features.html#the-features-section)
that can be enabled or disabled:
- **`default-tls`** _(enabled by default)_: Provides TLS support to connect
over HTTPS.
- **`native-tls`**: Enables TLS functionality provided by `native-tls`.
- **`rustls-tls`**: Enables TLS functionality provided by `rustls`.
- **`tokio`** _(enabled by default)_: Enables the usage with the `tokio` runtime.
- **`async-std`**: Enables the usage with the `async-std` runtime.
## License
Licensed under either of
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.