Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ai-engineering/evaluate/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ keywords: ["ai engineering", "setup", "authentication", "cli", "install"]
sidebarTitle: "Setup and auth"
---

import ReplaceEdgeDomain from "/snippets/replace-edge-domain.mdx"
import ReplaceDomain from "/snippets/replace-domain.mdx"
import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"

This guide walks you through installing the Axiom AI SDK and authenticating with the Axiom AI SDK CLI so your evaluation results are tracked and attributed correctly in the Axiom Console.
Expand Down Expand Up @@ -84,13 +84,13 @@ Instead of using OAuth, you can authenticate using environment variables:
export AXIOM_TOKEN="API_TOKEN"
export AXIOM_DATASET="DATASET_NAME"
export AXIOM_ORG_ID="ORGANIZATION_ID"
export AXIOM_URL="AXIOM_EDGE_DOMAIN"
export AXIOM_URL="AXIOM_DOMAIN"
```

<Info>
<ReplaceDatasetToken />
Replace `ORGANIZATION_ID` with the organization ID.
<ReplaceEdgeDomain />
<ReplaceDomain />
</Info>

## Create the Axiom configuration file
Expand Down
6 changes: 3 additions & 3 deletions ai-engineering/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ keywords: ["ai engineering", "getting started", "install", "setup", "configurati
---

import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"
import ReplaceEdgeDomain from "/snippets/replace-edge-domain.mdx"
import ReplaceDomain from "/snippets/replace-domain.mdx"
import Prerequisites from "/snippets/standard-prerequisites.mdx"
import AIInstrumentationApproaches from "/snippets/ai-instrumentation-approaches.mdx"

Expand Down Expand Up @@ -200,7 +200,7 @@ export default defineConfig({
Store environment variables in an `.env` file in the root of your project:

```bash .env
AXIOM_URL="AXIOM_EDGE_DOMAIN"
AXIOM_URL="AXIOM_DOMAIN"
AXIOM_TOKEN="API_TOKEN"
AXIOM_DATASET="DATASET_NAME"
OPENAI_API_KEY=""
Expand All @@ -211,7 +211,7 @@ ANTHROPIC_API_KEY=""

<Info>
<ReplaceDatasetToken />
<ReplaceEdgeDomain />
<ReplaceDomain />

Enter the API keys for the LLMs you want to work with.
</Info>
Expand Down
6 changes: 3 additions & 3 deletions apps/hex.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebarTitle: 'Hex'

import Prerequisites from "/snippets/standard-prerequisites.mdx"
import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"
import ReplaceEdgeDomain from "/snippets/replace-edge-domain.mdx"
import ReplaceDomain from "/snippets/replace-domain.mdx"
import ReplaceDataset from "/snippets/replace-dataset.mdx"

Hex is a powerful collaborative data platform that allows you to create notebooks with Python/SQL code and interactive visualizations.
Expand All @@ -21,7 +21,7 @@ This page explains how to integrate Hex with Axiom to visualize geospatial data
Send your sample location data to Axiom using the API endpoint. For example, the following HTTP request sends sample robot location data with latitude, longitude, status, and satellite information.

```bash
curl -X 'POST' 'https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME' \
curl -X 'POST' 'https://AXIOM_DOMAIN/v1/ingest/DATASET_NAME' \
-H 'Authorization: Bearer API_TOKEN' \
-H 'Content-Type: application/json' \
-d '[
Expand All @@ -39,7 +39,7 @@ curl -X 'POST' 'https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME' \

<Info>
<ReplaceDatasetToken />
<ReplaceEdgeDomain />
<ReplaceDomain />
</Info>

Verify that your data has been ingested correctly by running an APL query in the Axiom UI.
Expand Down
6 changes: 3 additions & 3 deletions guides/send-logs-from-apache-log4j.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ enlargeLogo: true

import Prerequisites from "/snippets/standard-prerequisites.mdx"
import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"
import ReplaceEdgeDomain from "/snippets/replace-edge-domain.mdx"
import ReplaceDomain from "/snippets/replace-domain.mdx"

Log4j is a Java logging framework developed by the Apache Software Foundation and widely used in the Java community. This page covers how to get started with Log4j, configure it to forward log messages to Fluentd, and send logs to Axiom.

Expand Down Expand Up @@ -354,7 +354,7 @@ To configure Fluentd, create a configuration file. Create a new file named `flue

<match **>
@type http
endpoint https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME
endpoint https://AXIOM_DOMAIN/v1/ingest/DATASET_NAME
headers {"Authorization":"Bearer API_TOKEN"}
json_array true
<buffer>
Expand All @@ -371,7 +371,7 @@ To configure Fluentd, create a configuration file. Create a new file named `flue

<Info>
<ReplaceDatasetToken />
<ReplaceEdgeDomain />
<ReplaceDomain />
</Info>

This configuration does the following:
Expand Down
10 changes: 5 additions & 5 deletions guides/send-logs-from-dotnet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ logoId: 'dotnet'

import Prerequisites from "/snippets/standard-prerequisites.mdx"
import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"
import ReplaceEdgeDomain from "/snippets/replace-edge-domain.mdx"
import ReplaceDomain from "/snippets/replace-domain.mdx"

<Prerequisites />
- [Install the .NET SDK](https://dotnet.microsoft.com/download).
Expand Down Expand Up @@ -51,7 +51,7 @@ public static class AxiomLogger

// Specify the Axiom dataset name and construct the API endpoint URL
var datasetName = "DATASET_NAME";
var axiomEdgeDomain = "AXIOM_EDGE_DOMAIN";
var axiomEdgeDomain = "AXIOM_DOMAIN";
var axiomUri = $"https://{axiomEdgeDomain}/v1/ingest/{datasetName}";

// Replace with your Axiom API token
Expand Down Expand Up @@ -95,7 +95,7 @@ public static class AxiomLogger

<Info>
<ReplaceDatasetToken />
<ReplaceEdgeDomain />
<ReplaceDomain />
</Info>

### Configure the main program
Expand Down Expand Up @@ -415,7 +415,7 @@ Set up NLog by creating an `NLog.config` file or configuring it programmatically
flushTimeout="5000">
<target xsi:type="HTTP"
name="axiom"
url="https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME"
url="https://AXIOM_DOMAIN/v1/ingest/DATASET_NAME"
HttpHeaders="Authorization: Bearer API_TOKEN"
contentType="application/json">
<layout xsi:type="JsonLayout" includeAllProperties="true">
Expand All @@ -436,7 +436,7 @@ Set up NLog by creating an `NLog.config` file or configuring it programmatically

<Info>
<ReplaceDatasetToken />
<ReplaceEdgeDomain />
<ReplaceDomain />
</Info>

### Configure the main program
Expand Down
6 changes: 3 additions & 3 deletions guides/send-logs-from-laravel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ logoId: 'laravel'

import Prerequisites from "/snippets/standard-prerequisites.mdx"
import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"
import ReplaceEdgeDomain from "/snippets/replace-edge-domain.mdx"
import ReplaceDomain from "/snippets/replace-domain.mdx"

This guide explains integrating Axiom as a logging solution in a Laravel app. Using Axiom’s capabilities with a custom log channel, you can efficiently send your app’s logs to Axiom for storage, analysis, and monitoring. This integration uses Monolog, Laravel’s underlying logging library, to create a custom logging handler that forwards logs to Axiom.

Expand Down Expand Up @@ -133,14 +133,14 @@ The `default` configuration specifies the primary channel Laravel uses for loggi
LOG_CHANNEL=axiom
AXIOM_API_TOKEN=API_TOKEN
AXIOM_DATASET=DATASET_NAME
AXIOM_DOMAIN=AXIOM_EDGE_DOMAIN
AXIOM_DOMAIN=AXIOM_DOMAIN
LOG_LEVEL=debug
LOG_DEPRECATIONS_CHANNEL=null
```

<Info>
<ReplaceDatasetToken />
<ReplaceEdgeDomain />
<ReplaceDomain />
</Info>

### Deprecations log channel
Expand Down
6 changes: 3 additions & 3 deletions guides/send-logs-from-ruby-on-rails.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ logoId: 'ruby'
---

import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"
import ReplaceEdgeDomain from "/snippets/replace-edge-domain.mdx"
import ReplaceDomain from "/snippets/replace-domain.mdx"
import Prerequisites from "/snippets/standard-prerequisites.mdx"

This guide provides step-by-step instructions on how to send logs from a Ruby on Rails app to Axiom using the Faraday library. By following this guide, you configure your Rails app to send logs to Axiom, allowing you to monitor and analyze your app logs effectively.
Expand Down Expand Up @@ -48,7 +48,7 @@ require 'json'
class AxiomLogger
def self.send_log(log_data)
dataset_name = "DATASET_NAME"
axiom_ingest_api_url = "https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME"
axiom_ingest_api_url = "https://AXIOM_DOMAIN/v1/ingest/DATASET_NAME"
ingest_token = "API_TOKEN"

conn = Faraday.new(url: axiom_ingest_api_url) do |faraday|
Expand All @@ -75,7 +75,7 @@ end

<Info>
<ReplaceDatasetToken />
<ReplaceEdgeDomain />
<ReplaceDomain />
</Info>

## Test with the Axiom logger
Expand Down
2 changes: 1 addition & 1 deletion reference/limits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The table below summarizes the limits applied to each pricing plan. For more det
| Users | 1 | 1,000 * |
| [Monitors](/monitor-data/monitors) | 3 | 500 * |
| [Notifiers](/monitor-data/notifiers-overview) | Email, Discord | All supported |
| [Supported deployment regions](/reference/regions) | US | US |
| [Supported edge deployments](/reference/edge-deployments) | US | US |

\* Soft limit that can be increased upon request.

Expand Down
6 changes: 3 additions & 3 deletions reference/organization-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ keywords: ['axiom documentation', 'documentation', 'axiom', 'api token', 'person

import AiSetting from "/snippets/ai-setting.mdx"

## View organization ID
## Determine organization ID

1. Click <Icon icon="gear" iconType="solid"/> **Settings > General**.
1. Find organization ID in the **ID** section.

## View organization region
## Determine organization edge deployment

1. Click <Icon icon="gear" iconType="solid"/> **Settings > General**.
1. Find organization region in the **Region** section.
1. Find your organization’s default edge deployment in the **Edge deployment** section.

For more information, see [Edge deployments](/reference/edge-deployments).

Expand Down
2 changes: 1 addition & 1 deletion reference/usage-billing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ To upgrade or downgrade your plan:

You can manage the following add-ons:

- Additional regions
- Additional edge deployments
- Audit log
- Directory Sync
- Role-Based Access Control (RBAC)
Expand Down
36 changes: 18 additions & 18 deletions restapi/ingest.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ keywords: ['axiom documentation', 'documentation', 'axiom', 'axiom api', 'rest a

import Prerequisites from "/snippets/standard-prerequisites.mdx"
import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"
import ReplaceEdgeDomain from "/snippets/replace-edge-domain.mdx"
import ReplaceDomain from "/snippets/replace-domain.mdx"

The Axiom REST API accepts the following data formats:

Expand Down Expand Up @@ -35,10 +35,10 @@ To send data to Axiom in JSON format:
1. Optional: In the body of the request, set optional parameters such as `timestamp-field` and `timestamp-format`. For more information, see the [ingest data API reference](/restapi/endpoints/ingestToDataset).
1. Set the `Content-Type` header to `application/json`.
1. Set the `Authorization` header to `Bearer API_TOKEN`.
1. Send the POST request to `https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME`.
1. Send the POST request to `https://AXIOM_DOMAIN/v1/ingest/DATASET_NAME`.

<Info>
<ReplaceEdgeDomain />
<ReplaceDomain />
<ReplaceDatasetToken />
</Info>

Expand All @@ -49,7 +49,7 @@ The following example request contains grouped events. The structure of the JSON
**Example request**

```bash
curl -X 'POST' 'https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME' \
curl -X 'POST' 'https://AXIOM_DOMAIN/v1/ingest/DATASET_NAME' \
-H 'Authorization: Bearer API_TOKEN' \
-H 'Content-Type: application/json' \
-d '[
Expand All @@ -65,7 +65,7 @@ curl -X 'POST' 'https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME' \
```

<Info>
<ReplaceEdgeDomain />
<ReplaceDomain />
<ReplaceDatasetToken />
</Info>

Expand All @@ -87,7 +87,7 @@ curl -X 'POST' 'https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME' \
**Example request**

```bash
curl -X 'POST' 'https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME' \
curl -X 'POST' 'https://AXIOM_DOMAIN/v1/ingest/DATASET_NAME' \
-H 'Authorization: Bearer API_TOKEN' \
-H 'Content-Type: application/json' \
-d '[
Expand Down Expand Up @@ -133,7 +133,7 @@ curl -X 'POST' 'https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME' \
```

<Info>
<ReplaceEdgeDomain />
<ReplaceDomain />
<ReplaceDatasetToken />
</Info>

Expand All @@ -155,7 +155,7 @@ curl -X 'POST' 'https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME' \
**Example request**

```bash
curl -X 'POST' 'https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME' \
curl -X 'POST' 'https://AXIOM_DOMAIN/v1/ingest/DATASET_NAME' \
-H 'Authorization: Bearer API_TOKEN' \
-H 'Content-Type: application/json' \
-d '[{ "axiom": {
Expand All @@ -177,7 +177,7 @@ curl -X 'POST' 'https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME' \
```

<Info>
<ReplaceEdgeDomain />
<ReplaceDomain />
<ReplaceDatasetToken />
</Info>

Expand All @@ -202,17 +202,17 @@ To send data to Axiom in NDJSON format:
1. Optional: In the body of the request, set optional parameters such as `timestamp-field` and `timestamp-format`. For more information, see the [ingest data API reference](/restapi/endpoints/ingestToDataset).
1. Set the `Content-Type` header to either `application/json` or `application/x-ndjson`.
1. Set the `Authorization` header to `Bearer API_TOKEN`. Replace `API_TOKEN` with the Axiom API token you have generated.
1. Send the POST request to `https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME`. Replace `DATASET_NAME` with the name of the Axiom dataset where you want to send data.
1. Send the POST request to `https://AXIOM_DOMAIN/v1/ingest/DATASET_NAME`. Replace `DATASET_NAME` with the name of the Axiom dataset where you want to send data.

<Info>
<ReplaceEdgeDomain />
<ReplaceDomain />
<ReplaceDatasetToken />
</Info>

**Example request**

```bash
curl -X 'POST' 'https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME' \
curl -X 'POST' 'https://AXIOM_DOMAIN/v1/ingest/DATASET_NAME' \
-H 'Authorization: Bearer API_TOKEN' \
-H 'Content-Type: application/x-ndjson' \
-d '{"id":1,"name":"machala"}
Expand All @@ -224,7 +224,7 @@ curl -X 'POST' 'https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME' \
```

<Info>
<ReplaceEdgeDomain />
<ReplaceDomain />
<ReplaceDatasetToken />
</Info>

Expand All @@ -249,25 +249,25 @@ To send data to Axiom in JSON format:
1. Optional: In the body of the request, set optional parameters such as `timestamp-field` and `timestamp-format`. For more information, see the [ingest data API reference](/restapi/endpoints/ingestToDataset).
1. Set the `Content-Type` header to `text/csv`.
1. Set the `Authorization` header to `Bearer API_TOKEN`. Replace `API_TOKEN` with the Axiom API token you have generated.
1. Send the POST request to `https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME`. Replace `DATASET_NAME` with the name of the Axiom dataset where you want to send data.
1. Send the POST request to `https://AXIOM_DOMAIN/v1/ingest/DATASET_NAME`. Replace `DATASET_NAME` with the name of the Axiom dataset where you want to send data.

<Info>
<ReplaceDatasetToken />
<ReplaceEdgeDomain />
<ReplaceDomain />
</Info>

**Example request**

```bash
curl -X 'POST' 'https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME' \
curl -X 'POST' 'https://AXIOM_DOMAIN/v1/ingest/DATASET_NAME' \
-H 'Authorization: Bearer API_TOKEN' \
-H 'Content-Type: text/csv' \
-d 'user, name
foo, bar'
```

<Info>
<ReplaceEdgeDomain />
<ReplaceDomain />
<ReplaceDatasetToken />
</Info>

Expand Down Expand Up @@ -296,7 +296,7 @@ curl -X 'POST' 'https://AXIOM_EDGE_DOMAIN/v1/ingest/DATASET_NAME' \
```

<Info>
<ReplaceEdgeDomain />
<ReplaceDomain />
<ReplaceDatasetToken />
</Info>

Expand Down
Loading