https://github.com/axiomhq/axiom-js

Official language bindings and library extensions for Axiom
https://github.com/axiomhq/axiom-js

api axiom javascript sdk typescript winston

Last synced: 3 months ago
JSON representation

Official language bindings and library extensions for Axiom

• Host: GitHub
• URL: https://github.com/axiomhq/axiom-js
• Owner: axiomhq
• License: mit
• Created: 2023-02-02T12:23:41.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-21T16:48:20.000Z (6 months ago)
• Last Synced: 2024-05-22T10:45:20.359Z (6 months ago)
• Topics: api, axiom, javascript, sdk, typescript, winston
• Language: TypeScript
• Homepage: https://axiom.co
• Size: 1.49 MB
• Stars: 80
• Watchers: 5
• Forks: 10
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Contributing: Contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# axiom-js



  

  

  

  



 

[![Workflow][workflow_badge]][workflow]

[![License][license_badge]][license]

[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).

## Projects

This is a monorepo, for specific documentation, check out the different projects:

* [`@axiomhq/js`](./packages/js): Official API bindings that let you ingest or query your data.

* [`@axiomhq/winston`](./packages/winston): A [winston](https://github.com/winstonjs/winston) transport which sends logs to Axiom.

* [`@axiomhq/pino`](./packages/pino): A [pino](https://github.com/pinojs/pino) transport which sends logs to Axiom.

## Migrate to v1.x

- Pass the credentials as an object to Axiom client, this package no longer reads them from the environment variables.

  do:

  ```ts

    const axiom = new Axiom({

      token: process.env.AXIOM_TOKEN,

    });

  ```

  instead of:

  ```ts

  const axiom = new Axiom();

  ```

## License

Distributed under the [MIT License](LICENSE).

[workflow]: https://github.com/axiomhq/axiom-js/actions/workflows/ci.yml

[workflow_badge]: https://img.shields.io/github/actions/workflow/status/axiomhq/axiom-js/ci.yml?branch=main&ghcache=unused

[license]: https://opensource.org/licenses/MIT

[license_badge]: https://img.shields.io/github/license/axiomhq/axiom-js.svg?color=blue&ghcache=unused