Skip to content

Commit e556efb

Browse files
tothmanotothmano
authored
Merge branch 'main' into mano/rewrite-get-started
2 parents 6c07d2e + 479286e commit e556efb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+6182
-1784
lines changed

‎apl/scalar-operators/string-operators.mdx

+123-138
Large diffs are not rendered by default.

‎docs.json

+116-18
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"$schema": "https://mintlify.com/docs.json",
3-
"theme": "mint",
3+
"theme": "maple",
44
"name": "Axiom Docs",
55
"description": "Axiom’s official documentation site. Learn everything about how to use Axiom.",
66
"colors": {
@@ -280,6 +280,14 @@
280280
},
281281
"reference/security"
282282
]
283+
},
284+
{
285+
"group": "LLMs",
286+
"pages": [
287+
"llms/llms-overview",
288+
"llms/llms",
289+
"llms/llms-full"
290+
]
283291
}
284292
]
285293
},
@@ -502,43 +510,118 @@
502510
]
503511
},
504512
{
505-
"group": "User endpoints",
513+
"group": "Annotation endpoints",
506514
"pages": [
507-
"restapi/endpoints/getCurrentUser"
515+
"restapi/endpoints/getAnnotations",
516+
"restapi/endpoints/getAnnotation",
517+
"restapi/endpoints/createAnnotation",
518+
"restapi/endpoints/updateAnnotation",
519+
"restapi/endpoints/deleteAnnotation"
520+
]
521+
},
522+
{
523+
"group": "API token endpoints",
524+
"pages": [
525+
"restapi/endpoints/getTokens",
526+
"restapi/endpoints/getToken",
527+
"restapi/endpoints/createToken",
528+
"restapi/endpoints/regenerateToken",
529+
"restapi/endpoints/deleteToken"
508530
]
509531
},
510532
{
511533
"group": "Dataset endpoints",
512534
"pages": [
513535
"restapi/endpoints/getDatasets",
514536
"restapi/endpoints/getDataset",
537+
"restapi/endpoints/getFieldsForDataset",
538+
"restapi/endpoints/getFieldForDataset",
515539
"restapi/endpoints/createDataset",
516540
"restapi/endpoints/ingestIntoDataset",
517541
"restapi/endpoints/queryApl",
518542
"restapi/endpoints/queryDataset",
519543
"restapi/endpoints/trimDataset",
520544
"restapi/endpoints/updateDataset",
545+
"restapi/endpoints/updateFieldForDataset",
546+
"restapi/endpoints/vacuumDataset",
521547
"restapi/endpoints/deleteDataset"
522548
]
523549
},
524550
{
525-
"group": "Annotation endpoints",
551+
"group": "Monitor endpoints",
526552
"pages": [
527-
"restapi/endpoints/getAnnotations",
528-
"restapi/endpoints/getAnnotation",
529-
"restapi/endpoints/createAnnotation",
530-
"restapi/endpoints/updateAnnotation",
531-
"restapi/endpoints/deleteAnnotation"
553+
"restapi/endpoints/getMonitors",
554+
"restapi/endpoints/getMonitor",
555+
"restapi/endpoints/getMonitorHistory",
556+
"restapi/endpoints/createMonitor",
557+
"restapi/endpoints/updateMonitor",
558+
"restapi/endpoints/deleteMonitor"
532559
]
533560
},
534561
{
535-
"group": "API token endpoints",
562+
"group": "Notifier endpoints",
536563
"pages": [
537-
"restapi/endpoints/getTokens",
538-
"restapi/endpoints/getToken",
539-
"restapi/endpoints/createToken",
540-
"restapi/endpoints/regenerateToken",
541-
"restapi/endpoints/deleteToken"
564+
"restapi/endpoints/getNotifiers",
565+
"restapi/endpoints/getNotifier",
566+
"restapi/endpoints/createNotifier",
567+
"restapi/endpoints/updateNotifier",
568+
"restapi/endpoints/deleteNotifier"
569+
]
570+
},
571+
{
572+
"group": "Organization endpoints",
573+
"pages": [
574+
"restapi/endpoints/getOrgs",
575+
"restapi/endpoints/getOrg",
576+
"restapi/endpoints/createOrg",
577+
"restapi/endpoints/updateOrg"
578+
]
579+
},
580+
{
581+
"group": "Role-based access control endpoints",
582+
"pages": [
583+
"restapi/endpoints/listRoles",
584+
"restapi/endpoints/getRoleById",
585+
"restapi/endpoints/listGroups",
586+
"restapi/endpoints/getGroupById",
587+
"restapi/endpoints/createRole",
588+
"restapi/endpoints/createGroup",
589+
"restapi/endpoints/updateRole",
590+
"restapi/endpoints/updateGroup",
591+
"restapi/endpoints/deleteRole",
592+
"restapi/endpoints/deleteGroup"
593+
]
594+
},
595+
{
596+
"group": "Starred queries endpoints",
597+
"pages": [
598+
"restapi/endpoints/getStarredQueries",
599+
"restapi/endpoints/getStarred",
600+
"restapi/endpoints/createStarred",
601+
"restapi/endpoints/updateStarred",
602+
"restapi/endpoints/deleteStarred"
603+
]
604+
},
605+
{
606+
"group": "User endpoints",
607+
"pages": [
608+
"restapi/endpoints/getCurrentUser",
609+
"restapi/endpoints/getUsers",
610+
"restapi/endpoints/getUser",
611+
"restapi/endpoints/createUser",
612+
"restapi/endpoints/updateCurrentUser",
613+
"restapi/endpoints/updateUserRole",
614+
"restapi/endpoints/removeUserFromOrg"
615+
]
616+
},
617+
{
618+
"group": "Virtual fields endpoints",
619+
"pages": [
620+
"restapi/endpoints/getVirtualFields",
621+
"restapi/endpoints/getVirtualField",
622+
"restapi/endpoints/createVirtualField",
623+
"restapi/endpoints/updateVirtualField",
624+
"restapi/endpoints/deleteVirtualField"
542625
]
543626
}
544627
]
@@ -592,15 +675,30 @@
592675
}
593676
},
594677
"seo": {
595-
"indexing": "navigable"
678+
"indexing": "navigable",
679+
"metatags": {
680+
"og:site_name": "Axiom",
681+
"og:title": "Axiom Docs",
682+
"og:description": "Axiom’s official documentation site. Learn everything about how to use Axiom."
683+
}
596684
},
597685
"footer": {
598686
"socials": {
599-
"twitter": "https://twitter.com/AxiomFM",
687+
"x": "https://x.com/AxiomFM",
600688
"github": "https://github.com/axiomhq",
601-
"linkedin": "https://linkedin.com/company/axiomhq"
689+
"linkedin": "https://linkedin.com/company/axiomhq",
690+
"discord": "https://axiom.co/discord"
602691
}
603692
},
693+
"contextual": {
694+
"options": [
695+
"copy",
696+
"view"
697+
]
698+
},
699+
"styling": {
700+
"eyebrows": "breadcrumbs"
701+
},
604702
"integrations": {
605703
"fathom": {
606704
"siteId": "BGVZPGXQ"

‎get-help/faq.mdx

+38-13
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,40 @@ This page aims to offer a deeper understanding of Axiom. If you can’t find an
1313

1414
Axiom is a log management and analytics solution that reduces the cost and management overhead of logging as much data as you want.
1515

16-
With Axiom, organizations no longer need to choose between their data and their costs. Axiom has been built from the ground-up to allow for highly efficient data ingestion and storage, and then a zero-to-infinite query scaling that allows you to query all your data, all the time.
16+
With Axiom, organizations no longer need to choose between their data and their costs. Axiom has been built from the ground up to allow for highly efficient data ingestion and storage, and then a zero-to-infinite query scaling that allows you to query all your data, all the time.
1717

1818
Organizations use Axiom for continuous monitoring and observability, as well as an event store for running analytics and deriving insights from all their event data.
1919

20-
Axiom consists of a datastore and a user-experience that work in tandem to provide a completely unique log-management and analytics experience.
20+
Axiom consists of a datastore and a user experience that work in tandem to provide a completely unique log-management and analytics experience.
21+
22+
## What are Axiom's deployment options?
23+
24+
Axiom offers two deployment options:
25+
- **Axiom Cloud:** A fully managed cloud service with usage-based pricing.
26+
- **Bring Your Own Cloud (BYOC):** Deploy Axiom in your own cloud environment with a predictable annual platform fee.
2127

2228
## Can I run Axiom in my own cloud/infrastructure?
2329

24-
Axiom enables you to store data in your own storage with the Bring Your Own Bucket (BYOB) feature. You provide your own S3-compatible object storage, and the Axiom control plane handles ingest, query execution, and all other background tasks. This is not an on-premises solution, but it enables you to maintain control over your data at rest.
30+
Axiom enables you to store data in your own storage in one of the following ways:
31+
32+
- **Bring Your Own Bucket (BYOB):** BYOB is a feature you can request as an add-on if you’re on the Axiom Cloud plan. You provide your own S3-compatible object storage, and the Axiom control plane handles ingest, query execution, and all other background tasks. This is not an on-premises solution, but it enables you to maintain control over your data at rest.
33+
- **Bring Your Own Cloud (BYOC):** BYOC is an alternative deployment option and pricing plan. We deploy Axiom into your own AWS infrastructure, and you store and process data in your own environment.
34+
35+
## How do I choose between Axiom Cloud and BYOC?
36+
37+
Choose Axiom Cloud if you prefer quick setup, usage-based pricing, and don’t need to keep data in your own cloud environment.
38+
39+
Choose BYOC if you require data isolation, have compliance requirements necessitating data storage in your environment, can benefit from your cloud provider’s volume discounts, or have very large-scale workloads.
2540

26-
Using Axiom as a cloud SaaS product without the BYOB option is safe, affordable, and the best choice for most use cases. Billed month-to-month on our [Team plan](https://axiom.co/pricing) for ingest workloads up to 50TB/mo, and with no upper limit on our annual [Enterprise plan](https://axiom.co/pricing), Axiom supports tens of thousands of organizations today. However, if you are a large enterprise customer and your organization requires data sovereignty for compliance reasons or secondary workloads, using Axiom with the BYOB premium option is the answer.
41+
For more information, see [Pricing](https://axiom.co/pricing).
2742

28-
Axiom BYOB is available exclusively on our annual [Enterprise plan](https://axiom.co/pricing).
43+
## What regions are available for Axiom Cloud deployments?
44+
45+
Axiom Cloud offers deployments in both US and EU regions. For more information, see [Regions](/reference/regions).
46+
47+
## Can I migrate from Axiom Cloud to BYOC later?
48+
49+
Yes, Axiom can support migration between deployment options. The Axiom team can assist with this process. If you expect to require a migration, we recommend reaching out to our team in advance.
2950

3051
## How is Axiom different than other logging solutions?
3152

@@ -65,22 +86,26 @@ The end result is needing to carefully consider all data that is ingested, and p
6586

6687
5. Free your organization to do more with it’s data
6788

68-
## How long can I retain data for with Axiom?
89+
## How long can I retain data with Axiom?
6990

70-
Axiom’s free forever [Personal plan](https://axiom.co/pricing) provides a generous 30 days of retention.
91+
The free forever Personal plan provides a generous 30 days of retention.
7192

72-
Axiom’s [Team plan](https://axiom.co/pricing) provides 95 days of retention, ensuring a complete picture of your data for over 3 months.
93+
The Axiom Cloud and the Bring Your Own Cloud plans allow you to customize the data retention period to your needs, with the option for “Forever” retention so your organization has access to all its data, all the time.
7394

74-
Retention on Axiom’s [Enterprise plan](https://axiom.co/pricing) can be customised to your needs, with the option for unlimited retention so your organization has access to all its data, all the time.
95+
For more information, see [Pricing](https://axiom.co/pricing).
7596

7697
## Can I try Axiom for free?
7798

78-
Yes. Axiom’s [Personal plan](https://axiom.co/pricing) is free forever with a generous allowance, and is available to all customers.
99+
Yes. The Personal plan is free forever with a generous allowance. It is available to all customers.
79100

80-
With unlimited users included, Axiom’s [Team plan](https://axiom.co/pricing) starting at $25/mo is a great choice for growing companies, and for Enterprise organizations who want to run a proof-of-concept.
101+
With unlimited users included, the Axiom Cloud plan starting at $25/month is a great choice for growing companies and for enterprise organizations who want to run a proof-of-concept.
102+
103+
For more information, see [Pricing](https://axiom.co/pricing).
81104

82105
## How is Axiom licensed?
83106

84-
Axiom’s [Team plan](https://axiom.co/pricing) is billed on a monthly basis.
107+
The Axiom Cloud plan is billed on a monthly basis.
108+
109+
For the Bring Your Own Cloud plan, the platform fee is billed on an annual basis.
85110

86-
Axiom’s [Enterprise plan](https://axiom.co/pricing) is billed on an annual basis, with license details tailored to your organization’s needs.
111+
For more information, see [Pricing](https://axiom.co/pricing).

‎getting-started-guide/glossary.mdx

+8
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ For more information, see [Introduction to apps](/apps/introduction).
3535
Axiom represents the next generation of business intelligence. Designed and built for the cloud, Axiom is an event platform for logs, traces, and all technical data.
3636
Axiom efficiently ingests, stores, and queries vast amounts of event data from any source at a fraction of the cost. The Axiom platform is built for unmatched efficiency, scalability, and performance.
3737

38+
### Axiom Cloud
39+
40+
Axiom Cloud is a deployment option and pricing plan with a fully managed cloud service and usage-based pricing.
41+
3842
### Axiom Processing Language (APL)
3943

4044
The Axiom Processing Language (APL) is a query language that is perfect for getting deeper insights from your data. Whether logs, events, analytics, or similar, APL provides the flexibility to filter, manipulate, and summarize your data exactly the way you need it.
@@ -47,6 +51,10 @@ For more information, see [Introduction to APL](/apl/introduction).
4751

4852
Axiom enables you to store data in your own storage with the Bring Your Own Bucket (BYOB) feature. You provide your own S3-compatible object storage, and the Axiom control plane handles ingest, query execution, and all other background tasks. This is not an on-premises solution, but it enables you to maintain control over your data at rest.
4953

54+
### Bring Your Own Cloud (BYOC)
55+
56+
BYOC is a deployment option and pricing plan. We deploy Axiom into your own AWS infrastructure, and you store and process data in your own environment.
57+
5058
## C
5159

5260
### CLI

‎llms/llms-full.mdx

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Full docs
3+
url: "https://axiom.co/docs/llms-full.txt"
4+
icon: robot
5+
---
6+
7+
Access the [full documentation](https://axiom.co/docs/llms-full.txt) in Markdown format and pass it to your LLM.

‎llms/llms-overview.mdx

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Interpret Axiom docs with LLMs
3+
description: "This page explains how to interpret Axiom docs with LLMs."
4+
sidebarTitle: Overview
5+
icon: microchip-ai
6+
---
7+
8+
## AI chat
9+
10+
To get an answer about Axiom from the documentation’s built-in AI assistant, press <kbd>Cmd/Ctrl</kbd>&nbsp;<kbd>K</kbd>, and then type your question.
11+
12+
## Interpret individual pages
13+
14+
To interpret individual pages of the documentation with an LLM, click <Icon icon="chevron-down" iconType="solid" /> in the top right, and then choose one of the following options:
15+
- Copy the page in Markdown format and manually pass it to LLMs
16+
- View the page in Markdown format and manually pass its URL to LLMs
17+
18+
## Interpret the full docs
19+
20+
To make it easy for LLMs to interpret the documentation, Axiom offers the following based on the [/llms.txt standard](https://llmstxt.org/):
21+
22+
- [List of docs pages](https://axiom.co/docs/llms.txt)
23+
- [Full documentation](https://axiom.co/docs/llms-full.txt)
24+
25+
Access one of the above documents and pass it to your LLM to start interpreting the Axiom documentation.

‎llms/llms.mdx

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: List of docs pages
3+
url: "https://axiom.co/docs/llms.txt"
4+
icon: list
5+
---
6+
7+
Access the [list of docs pages](https://axiom.co/docs/llms.txt) in Markdown format and pass it to your LLM.

0 commit comments

Comments
 (0)