Skip to content

Add docs satisfaction survey #328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
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
5 changes: 4 additions & 1 deletion apl/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ keywords: ['axiom documentation', 'documentation', 'axiom', 'APL', 'axiom proces
---

import Prerequisites from "/snippets/minimal-prerequisites.mdx"
import { Survey } from "/snippets/survey.jsx"

The Axiom Processing Language (APL) is a query language that’s 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.

Expand Down Expand Up @@ -94,4 +95,6 @@ Check out the [list of sample queries](/apl/tutorial) or explore the supported o
- [Scalar functions](/apl/scalar-functions/)
- [Aggregation functions](/apl/aggregation-function/)
- [Tabular operators](/apl/tabular-operators/)
- [Scalar operators](/apl/scalar-operators/)
- [Scalar operators](/apl/scalar-operators/)

<Survey />
4 changes: 4 additions & 0 deletions getting-started-guide/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ icon: rocket
keywords: ['axiom documentation', 'documentation', 'axiom', 'stream data', 'analyze data', 'explore data']
---

import { Survey } from "/snippets/survey.jsx"

<Frame caption="Axiom user interface">
<img src="/doc-assets/intro.png" alt="Axiom user interface" />
</Frame>
Expand Down Expand Up @@ -107,3 +109,5 @@ Choose one of the following learning pathways:

- [Try out Axiom](/getting-started-guide/try-out-axiom) for a more hands-on experience that allows you to explore Axiom and quickly leverage the power of your event data.
- [Learn about Axiom](/getting-started-guide/learn-about-axiom) for a more educational experience that explains the most important concepts and ideas behind Axiom and how your organization can benefit from Axiom’s offering.

<Survey />
4 changes: 4 additions & 0 deletions introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
keywords: ["axiom documentation", "axiom", "monitoring", "observability", "logging", "user guide", "best practices"]
---

import { Survey } from "/snippets/survey.jsx"

<Frame caption="Axiom user interface">
<img src="/doc-assets/intro.png" alt="Axiom user interface" />
</Frame>
Expand Down Expand Up @@ -46,7 +48,7 @@
</Card>
<Card
title="Create dashboards"
icon="chart-column"

Check warning on line 51 in introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

introduction.mdx#L51

Consider using 'field' instead of 'column'.
href="/dashboards"
>
Personalize custom models
Expand Down Expand Up @@ -99,3 +101,5 @@
- [Community](https://axiom.co/discord): Visit the Axiom Discord community to learn, ask questions, and discuss ideas.

- [Contact Support](https://axiom.co/contact): Get in touch with the support team for questions not covered here.

<Survey />
5 changes: 4 additions & 1 deletion restapi/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Get started with Axiom API'
description: 'This section explains how to send data to Axiom, query data, and manage resources using the Axiom API.'
overview: 'Standard interface for HTTP-based application programming'

Check warning on line 4 in restapi/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

restapi/introduction.mdx#L4

Use 'app' instead of 'application'.
sidebarTitle: Introduction
keywords: ['axiom documentation', 'documentation', 'axiom', 'axiom api', 'rest api', 'rest', 'content type', 'datasets', 'authentication', 'string', 'boolean', 'integer', 'float', 'map', 'list']
logoId: 'http'
Expand All @@ -13,6 +13,7 @@
import Prerequisites from "/snippets/minimal-prerequisites.mdx"
import ReplaceDomain from "/snippets/replace-domain.mdx"
import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"
import { Survey } from "/snippets/survey.jsx"

You can use the Axiom API (Application Programming Interface) to send data to Axiom, query data, and manage resources programmatically. This page covers the basics for interacting with the Axiom API.

Expand Down Expand Up @@ -91,4 +92,6 @@
## What's next

- [Ingest data via API](/restapi/ingest)
- [Query data via API](/restapi/query)
- [Query data via API](/restapi/query)

<Survey />
5 changes: 4 additions & 1 deletion send-data/ingest.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Send data'
description: "Use Axiom’s API to ingest, transport, and retrieve data from different sources such as relational databases, web logs, app logs, and kubernetes."
overview: 'Standard interface for HTTP-based application programming'

Check warning on line 4 in send-data/ingest.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

send-data/ingest.mdx#L4

Use 'app' instead of 'application'.
sidebarTitle: 'Overview'
icon: "paper-plane"
keywords: ['API', 'axiom documentation', 'documentation', 'axiom', 'send data', 'data shippers', 'apps', 'elasticsearch', 'endpoints', 'json', 'ndjson', 'csv']
Expand All @@ -10,6 +10,7 @@

import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"
import ReplaceDomain from "/snippets/replace-domain.mdx"
import { Survey } from "/snippets/survey.jsx"

Send (ingest), transport, and fetch data from different sources such as Relational database, web logs, batch data, real-time, app logs, streaming data, etc. for later usage with the Axiom API.

Expand Down Expand Up @@ -317,4 +318,6 @@
When sending data into Axiom, follow these best practices to optimize performance and reliability:
- **Batch events:** Use a log forwarder, [collector](#data-shippers), or [Axiom‘s official SDKs](#client-libraries) to group multiple events into a single request before sending them to Axiom. This reduces the number of API calls and improves overall throughput. Avoid implementing batching within your app itself as this introduces additional complexity and requires careful management of buffers and error handling.
- **Use compression:** Enable gzip, zstd compression for your requests to reduce bandwidth usage and potentially improve response time.
- **Handle rate limiting and errors:** Use [Axiom‘s official libraries and SDKs](#client-libraries) which automatically implement best practices for handling rate limiting and errors. For advanced use cases or custom implementations, consider adding a fallback mechanism to store events locally or in cold storage if ingestion consistently fails after retries.
- **Handle rate limiting and errors:** Use [Axiom‘s official libraries and SDKs](#client-libraries) which automatically implement best practices for handling rate limiting and errors. For advanced use cases or custom implementations, consider adding a fallback mechanism to store events locally or in cold storage if ingestion consistently fails after retries.

<Survey />
29 changes: 29 additions & 0 deletions snippets/survey.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
export const Survey = () => {
const ref = window.location.href;
useEffect(() => {
const scriptId = 'tally-embed';
if (!document.getElementById(scriptId)) {
const script = document.createElement('script');
script.id = scriptId;
script.src = 'https://tally.so/widgets/embed.js';
script.async = true;
document.body.appendChild(script);
}

window.TallyConfig = {
formId: 'wQqlyl',
popup: {
open: {
trigger: 'time',
ms: 10000, // 10 seconds
},
"hideTitle": true,
"autoClose": 3000,
"showOnce": true,
"doNotShowAfterSubmit": true,
},
};
}, []);

return null;
};