Skip to content

Commit bdf6407

Browse files
authored
Add feature states, clarify state of existing features (#196)
1 parent 0314e9a commit bdf6407

File tree

7 files changed

+39
-8
lines changed

7 files changed

+39
-8
lines changed

apl/tabular-operators/join-operator.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This operator is useful when you want to:
1212
- Enrich existing data with supplementary details.
1313

1414
<Note>
15-
The `join` operator is currently in preview. To try it out, [contact Axiom](https://axiom.co/contact).
15+
The `join` operator is currently in private preview. To try it out, [contact Axiom](https://axiom.co/contact).
1616

1717
The preview of the `join` operator works with an upper limit of 5,000 events on the left side of the join and 50,000 on the right side of the join.
1818
</Note>
+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: "Feature states in Axiom"
3+
description: "This section explains the feature states in Axiom."
4+
sidebarTitle: Feature states
5+
tags:
6+
['axiom documentation', 'documentation', 'axiom', 'feature states']
7+
---
8+
9+
Each feature of Axiom is in one of the following states:
10+
11+
- **In development:** Axiom is actively building this feature. It’s not available yet but it’s progressing towards Preview.
12+
- **Private preview:** An early-access feature available to selected customers which helps Axiom validate the feature with trusted partners.
13+
- **Public preview:** The feature is available for everyone to try but may have some rough edges. Axiom is gathering feedback before making it GA.
14+
- **Generally available (GA):** The feature is fully released, production-ready, and supported. Feel free to use it in your workflows.
15+
- **Planned end of life:** The feature is scheduled to be retired. It’s still working but you should start migrating to alternative solutions.
16+
- **End of life:** The feature is no longer available or supported. Axiom has sunset it in favor of newer solutions.
17+
18+
<Warning>
19+
Private and public preview features are experimental, are not guaranteed to work as expected, and may return unexpected query results. Please consider the risk you run when you use preview features against production workloads.
20+
</Warning>
21+
22+
Current private preview features:
23+
24+
- [Flow](/process-data/introduction)
25+
- [Join operator](/apl/tabular-operators/join-operator)
26+
- [Send data from Datadog to Axiom](/send-data/datadog)
27+
28+
Current public preview features:
29+
- [Cursor-based pagination](/restapi/pagination)

mint.json

+2
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@
8080
"pages": [
8181
"getting-started-guide/event-data",
8282
"getting-started-guide/observability",
83+
"getting-started-guide/feature-states",
8384
"getting-started-guide/glossary"
8485
]
8586
},
@@ -445,6 +446,7 @@
445446
"apl/tabular-operators/distinct-operator",
446447
"apl/tabular-operators/extend-operator",
447448
"apl/tabular-operators/extend-valid-operator",
449+
"apl/tabular-operators/join-operator",
448450
"apl/tabular-operators/limit-operator",
449451
"apl/tabular-operators/order-operator",
450452
"apl/tabular-operators/parse-operator",

process-data/destinations/manage-destinations.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: 'This page explains how to manage Flow destinations.'
44
---
55

66
<Note>
7-
Flow is currently in preview. To try it out, [sign up for a free account](https://app.axiom.co/flows).
7+
Flow is currently in private preview. To try it out, [sign up for a free account](https://app.axiom.co/flows).
88
</Note>
99

1010
To transform and route data from an Axiom dataset to a destination, you need to set up a destination. This is where data is routed. Once you set up a destination, it can be used in any flow configuration.

process-data/flows.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: 'This page explains how to set up a flow to filter, shape, and rout
66
import Prerequisites from "/snippets/minimal-prerequisites.mdx"
77

88
<Note>
9-
Flow is currently in preview. To try it out, [sign up for a free preview](https://app.axiom.co/flows).
9+
Flow is currently in private preview. To try it out, [sign up for a free preview](https://app.axiom.co/flows).
1010
</Note>
1111

1212
A flow is a way to filter, shape, and route data from an Axiom dataset to a destination that you choose. This page explains how to set up a flow.

process-data/introduction.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebarTitle: Introduction
77
Flow provides onward event processing, including filtering, shaping, and routing. Flow works after persisting data in Axiom’s highly efficient queryable store, and uses [APL](/apl/introduction) to define processing.
88

99
<Note>
10-
Flow is currently in preview. To try it out, [sign up for a free account](https://app.axiom.co/flows).
10+
Flow is currently in private preview. To try it out, [sign up for a free account](https://app.axiom.co/flows).
1111
</Note>
1212

1313
## Elements of a flow
@@ -25,7 +25,7 @@ There are three types of flows:
2525
- **Continuous flows** are continuously running operations that process your incoming data and route the outputs to a destination in real-time.
2626

2727
<Note>
28-
Flow is currently in preview, with support for one-time and continuous flows.
28+
Flow is currently in private preview, with support for one-time and continuous flows.
2929
</Note>
3030

3131
To get started with Flow, see [Configure Flow](/process-data/flows).

restapi/pagination.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ You can use pagination for the following endpoints:
1717
You can use one of the following pagination mechanisms:
1818

1919
- [Pagination based on timestamp](#timestamp-based-pagination) (stable)
20-
- [Pagination based on cursor](#cursor-based-pagination) (preview)
20+
- [Pagination based on cursor](#cursor-based-pagination) (public preview)
2121

22-
Axiom recommends timestamp-based pagination. Cursor-based pagination is in preview and may result in data loss.
22+
Axiom recommends timestamp-based pagination. Cursor-based pagination is in public preview and may return unexpected query results.
2323

2424
## Timestamp-based pagination
2525

@@ -129,7 +129,7 @@ curl -X 'POST' 'https://api.axiom.co/v1/datasets/{dataset_id}/query' \
129129

130130
## Cursor-based pagination
131131

132-
Cursor-based pagination is in preview and may result in data loss. Axiom recommends timestamp-based pagination.
132+
Cursor-based pagination is in public preview and may return unexpected query results. Axiom recommends timestamp-based pagination.
133133

134134
The parameters and mechanisms differ between the current and legacy endpoints.
135135

0 commit comments

Comments
 (0)