You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: dashboards/configure.mdx
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ To specify who can access a dashboard:
37
37
1. In the top right, click <imgsrc="/doc-assets/icons/share.svg"className="inline-icon"alt="Share" /> **Share**.
38
38
1. Select one of the following:
39
39
- Select **Just Me** to make the dashboard private. Only you can access the dashboard.
40
-
- Select a group in your Axiom organization. Only members of the selected group can access the dashboard. For more information about groups, see [Access](/reference/settings#access-overview).
40
+
- Select a group in your Axiom organization. Only members of the selected group can access the dashboard. For more information about groups, see [Access](/reference/settings#access).
41
41
- Select **Everyone** to make the dashboard accessible to all users in your Axiom organization.
42
42
1. At the bottom, click **Save** to save your changes to the dashboard.
Copy file name to clipboardExpand all lines: guides/opentelemetry-ruby.mdx
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ This guide provides detailed steps on how to configure OpenTelemetry in a Ruby a
12
12
## Prerequisites
13
13
14
14
-[Create an Axiom account](https://app.axiom.co/).
15
-
-[Create a dataset](/reference/settings#data) where you want to send data.
15
+
-[Create a dataset](/reference/settings#datasets) where you want to send data.
16
16
-[Create an API token in Axiom with permissions to ingest and query data](/reference/tokens).
17
17
- Install a [Ruby version manager](https://www.ruby-lang.org/en/documentation/installation/) like `rbenv` and use it to install the latest Ruby version.
18
18
- Install [Rails](https://guides.rubyonrails.org/v5.0/getting_started.html) using the `gem install rails` command.
Copy file name to clipboardExpand all lines: guides/send-logs-from-ruby-on-rails.mdx
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ This guide provides step-by-step instructions on how to send logs from a Ruby on
14
14
## Prerequisites
15
15
16
16
-[Create an Axiom account](https://app.axiom.co/).
17
-
-[Create a dataset](/reference/settings#data) where you want to send data.
17
+
-[Create a dataset](/reference/settings#datasets) where you want to send data.
18
18
-[Create an API token in Axiom with permissions to ingest and query data](/reference/tokens).
19
19
- Install a [Ruby version manager](https://www.ruby-lang.org/en/documentation/installation/) like `rbenv` and use it to install the latest Ruby version.
20
20
- Install [Ruby on Rails](https://guides.rubyonrails.org/v5.0/getting_started.html) using the `gem install rails` command.
Copy file name to clipboardExpand all lines: query-data/explore.mdx
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ Explain what you want to infer from your data in your own words and Axiom’s AI
25
25
1. Go to the Query tab.
26
26
1. Click **APL**, and then click in the query editor.
27
27
1. Press <kbd>Cmd/Ctrl</kbd> <kbd>K</kbd>.
28
-
1. Type what you want to infer from your data in your own words using natural language, and then click **Generate**. For example, type `Show me the top status responses in HTTP logs.`
28
+
1. Type what you want to infer from your data in your own words using natural language, and then click **Generate**. For example, type `Show me the most common status responses in HTTP logs.`
29
29
1. Axiom’s AI generates the APL query based on your prompt and gives you the following options:
30
30
- Click **Accept** to update the editor with the generated query and change the generated query before running it. Any previous input in the query editor is lost.
31
31
- Click **Accept and run** to update the editor with the generated query and run it immediately. Any previous input in the query editor is lost.
Copy file name to clipboardExpand all lines: reference/audit-log.mdx
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ The `action` field specifies the type of activity that happened in your Axiom or
37
37
38
38
## Restrict access to audit log
39
39
40
-
To restrict access to the audit log, use Axiom’s role-based access control to define who can access the `axiom-audit` dataset. For more information, see [Access](/reference/settings#access-overview).
40
+
To restrict access to the audit log, use Axiom’s role-based access control to define who can access the `axiom-audit` dataset. For more information, see [Access](/reference/settings#access).
Copy file name to clipboardExpand all lines: reference/regions.mdx
+9-5Lines changed: 9 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -11,12 +11,16 @@ The examples in this documentation use the US domain. If your organization uses
11
11
12
12
## Check your region
13
13
14
-
To check which region your organization uses, match the base domain in the Axiom web app with the table below:
14
+
Determine the region your organization usesin one of the following ways:
15
15
16
-
| Region | Base domain in web app |
17
-
| ---------- | ------------------------------ |
18
-
| US |`https://app.axiom.co`|
19
-
| EU |`https://app.eu.axiom.co`|
16
+
- Go to the [Axiom app](https://app.axiom.co/) and check the URL. Match the base domain in the Axiom web app with the table below:
17
+
18
+
| Region | Base domain in web app |
19
+
| ---------- | ------------------------------ |
20
+
| US |`https://app.axiom.co`|
21
+
| EU |`https://app.eu.axiom.co`|
22
+
23
+
- Click <imgsrc="/doc-assets/icons/settings.svg"className="inline-icon"alt="Settings icon" /> **Settings > General**, and then find the **Region** section.
Axiom complies with key standards and regulations.
@@ -34,6 +36,10 @@ Axiom complies with HIPAA and its core principles. HIPAA compliance means that A
34
36
35
37
If you’re on the Axiom Cloud or the Bring Your Own Cloud plan, you can request Business Associate Agreement (BAA). For more information, see the [Axiom Trust Center](https://trust.axiom.co/).
36
38
39
+
## Compliance and Axiom AI
40
+
41
+
<AiSetting />
42
+
37
43
## Comprehensive security measures
38
44
39
45
Axiom employs a multi-faceted approach to ensure data security, covering encryption, penetration testing, infrastructure security, and organizational measures.
This section walks you through the most essential Axiom settings.
12
-
13
-
## Access Overview
12
+
## Access
14
13
15
14
Role-Based Access Control (RBAC) enables organizations to manage and restrict access to their data and resources efficiently. You can find and configure RBAC settings in the Access section located within the settings page in Axiom.
16
15
@@ -27,6 +26,21 @@ Each of these components plays an important role in defining access to Axiom.
27
26
28
27
You can use the Axiom API and CLI to programmatically ingest data and manage your organisation settings. For example, you can add new notifiers and change existing monitors with API requests. To prove that these requests come from you, you must include forms of authentication called tokens in your API requests. One form of authentication is an API token. API tokens let you control the actions that can be performed with the token. For example, you can specify that requests authenticated with a certain API token can only query data from a particular dataset. For more information, see [Tokens](/reference/tokens).
29
28
29
+
### Groups
30
+
31
+
Groups connect users with roles, making it easier to manage access control at scale.
32
+
33
+
Organizations might create groups for areas of their business like Security, Infrastructure, or Business Analytics, with specific roles assigned to serve the unique needs of these domains.
34
+
35
+
Since groups connect users with one or many roles, users' complete set of capabilities are derived from the additive union of their base role, plus any roles assigned through group membership.
36
+
37
+
To create a new group:
38
+
39
+
1. Navigate to Groups and select New group.
40
+
1. Enter the name and description of the group.
41
+
1. Add users to the group. Clicking on Add users will display a list of available users.
42
+
1. Add roles to the group by clicking Add roles, which will present a list of available roles.
43
+
30
44
### Roles
31
45
32
46
Roles are sets of capabilities that define which actions a user can perform at both the organization and dataset levels.
@@ -35,35 +49,25 @@ Roles are sets of capabilities that define which actions a user can perform at b
35
49
Role-based access control (RBAC) is available as an add-on if you’re on the Axiom Cloud plan, and it’s included by default on the Bring Your Own Cloud plan.
36
50
</Note>
37
51
38
-
### Default roles
52
+
####Default roles
39
53
40
54
Axiom provides a set of default roles for all organizations:
41
55
42
-
-**Owner**: Assigns all capabilities across the entire Axiom platform.
56
+
- Owner: Assigns all capabilities across the entire Axiom platform.
57
+
- Admin: Assigns administrative capabilities but not Billing capabilities, which are reserved for Owners.
58
+
- User: Assigns standard access for regular users.
59
+
- Read-only: Assigns read capabilities for datasets, plus read access on various resources like dashboards, monitors, notifiers, users, queries, starred queries, and virtual fields.
60
+
- None: Assigns zero capabilities, useful for adopting the principle of least privilege when inviting new users. Users with this default role can have specific capabilities built up through Roles assigned to a Group.
43
61
44
-
-**Admin**: Assigns administrative capabilities but not Billing capabilities, which are reserved for Owners.
45
-
46
-
-**User**: Assigns standard access for regular users.
47
-
48
-
-**Read-only**: Assigns read capabilities for datasets, plus read access on various resources like dashboards, monitors, notifiers, users, queries, starred queries, and virtual fields.
49
-
50
-
-**None**: Assigns zero capabilities, useful for adopting the principle of least privilege when inviting new users. Users with this default role can have specific capabilities built up through Roles assigned to a Group.
51
-
52
-
### Prerequisites for creating roles
62
+
#### Create custom role
53
63
54
64
Users must have the create permission for the access control capability assigned in order to create custom roles, which is enabled for the default Owner and Admin roles.
55
65
56
-
### Creating a custom role
57
-
58
66
1. Navigate to Roles and select New role.
59
-
2. Enter the name and description of the role.
60
-
3. Assign capabilities: Roles can be assigned various permissions (create, read, update, and delete) across capabilities like Access control, API tokens, dashboards, and datasets.
61
-
62
-
<Framecaption="Create a custom role">
63
-
<imgsrc="/doc-assets/shots/creating-a-custom-role.png"alt="Create a custom role" />
64
-
</Frame>
67
+
1. Enter the name and description of the role.
68
+
1. Assign capabilities: Roles can be assigned various permissions (create, read, update, and delete) across capabilities like Access control, API tokens, dashboards, and datasets.
65
69
66
-
###Assigning capabilities to roles
70
+
#### Assign capabilities to roles
67
71
68
72
Role creation is split into organization-level and dataset-level capabilities. Each capability has options to assign create, read, update, or delete (CRUD) permissions.
69
73
@@ -115,44 +119,14 @@ Refer to the table below to learn more about these dataset-level capabilities:
115
119
116
120
<AccessToDatasets />
117
121
118
-
### Groups
119
-
120
-
Groups connect users with roles, making it easier to manage access control at scale.
121
-
122
-
Organizations might create groups for areas of their business like Security, Infrastructure, or Business Analytics, with specific roles assigned to serve the unique needs of these domains.
123
-
124
-
Since groups connect users with one or many roles, users' complete set of capabilities are derived from the additive union of their base role, plus any roles assigned through group membership.
125
-
126
-
### Creating a New Group
127
-
128
-
1. Navigate to Groups and select New group.
129
-
130
-
2. Enter the name and description of the group.
131
-
132
-
<Framecaption="Create a group">
133
-
<imgsrc="/doc-assets/shots/create-new-group-1.png"alt="Create a group" />
134
-
</Frame>
135
-
136
-
3. Add users to the group. Clicking on Add users will display a list of available users.
137
-
138
-
<Framecaption="Create a group with users">
139
-
<imgsrc="/doc-assets/shots/create-new-group-rbac-2.png"alt="Create a group with users" />
140
-
</Frame>
141
-
142
-
4. Add roles to the group by clicking Add roles, which will present a list of available roles.
143
-
144
-
### Users
122
+
### Users
145
123
146
124
Users in Axiom are the individual accounts that have access to an organization. Users are assigned a base role when joining an organization which is configured during the invite step. For organizations with the role-based access control (RBAC) add-on, additional roles can be added through group membership.
147
125
148
-
### Managing Users
126
+
To manage users:
149
127
150
128
1. Navigate to Settings and select Users.
151
-
2. Review and manage the list of users and assign default or custom base roles as desired.
152
-
153
-
<Framecaption="Create a group">
154
-
<imgsrc="/doc-assets/shots/managing-users-settings.png"alt="Create a group" />
155
-
</Frame>
129
+
1. Review and manage the list of users and assign default or custom base roles as desired.
156
130
157
131
Access for a user is the additive union of capabilities assigned through their default role, plus any capabilities included in roles assigned through group membership.
158
132
@@ -174,82 +148,64 @@ Enrich your Axiom organization with a catalog of migrations tools, and dedicated
174
148
175
149
By properly monitoring your apps with Axiom, you can spot slowdowns, hiccups, bad requests, errored requests, and function cache performance and know which actions to take to correct these issues before there are user-facing consequences.
Manage datasets for your organization, including creating new datasets or deleting existing datasets.
186
156
187
-
Datasets are a collection of similar events. When data is sent to Axiom it is stored in a dataset.
188
157
189
-
Dataset names must be between 1-128 characters, and may only contain ASCII alphanumeric characters and the '-' character.
158
+
### Endpoints
190
159
191
-
To create a dataset, enter the name and description of your dataset.
160
+
Endpoints allow you to easily integrate Axiom into your existing data flow using tools and libraries that you already know. With Endpoints, you can build and configure your existing tooling to send data to Axiom so you can start monitoring your logs immediately.
Once created, you can import files into your datasets in supported formats such as NDJSON, JSON, or CSV. Additionally, you have the options to trim the dataset and delete it as needed.
To determine the organization ID, click <imgsrc="/doc-assets/icons/settings.svg"className="inline-icon"alt="Settings icon" /> **Settings > General**, and then find the **ID** section.
202
167
203
-
### Endpoints
168
+
### View organization region
204
169
205
-
Endpoints allow you to easily integrate Axiom into your existing data flow using tools and libraries that you already know. With Endpoints, you can build and configure your existing tooling to send data to Axiom so you can start monitoring your logs immediately.
170
+
To determine the region your organization uses, click <imgsrc="/doc-assets/icons/settings.svg"className="inline-icon"alt="Settings icon" /> **Settings > General**, and then find the **Region** section.
For more information, see [Regions](/reference/regions).
210
173
211
-
##Organization
174
+
### Turn Axiom AI on or off
212
175
213
-
### Billing
176
+
<AiSetting />
214
177
215
-
Manage your project billing, view your current plan, and explore the total usage of each component during your current billing period up to the last hour.
178
+
### Delete organization
216
179
217
-
You can upgrade your organization to a free 14-day trial. Axiom will not charge you during the first 14 days of your Axiom Pro trial. You can cancel at any time during the trial period without incurring any cost.
180
+
<Warning>
181
+
This is a destructive action. After you delete your organization, you lose access to all data within that org.
182
+
</Warning>
218
183
219
-
At the end of the trial period, your account will automatically convert to a paid plan.
184
+
To delete your organization:
220
185
221
-
On the Billings dashboard you can get the total usage of each running component during the current billing period up to the last hour and beyond.
186
+
1. Back up your data. You will now be able to access the data after deleting the org.
The Usage page gives you information about your organization’s total usage of Axiom.
244
199
245
200
## Profile
246
201
247
-
In the Profile section, you can configure the following:
202
+
In the Profile page, you can configure the following:
203
+
248
204
- Change your name.
249
205
- View your contact details and role.
250
206
- Change your timezone.
251
207
- Change the editor mode.
252
208
- Select the default method for null values. When you run a query with a visualization, you can select how Axiom treats null values in the chart options. For more information, see [Configure chart options](/query-data/explore#configure-chart-options). When you select a default method to deal with null values, Axiom uses this method in every new chart you create.
253
-
- View and manage your active sessions.
254
209
- Create and delete personal access tokens. For more information, see [Personal access tokens](/reference/tokens#personal-access-tokens-pat).
Copy file name to clipboardExpand all lines: reference/tokens.mdx
+2-6Lines changed: 2 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -97,10 +97,6 @@ If you authenticate requests with a PAT, you must include the org ID in the requ
97
97
98
98
Determine the org ID in one of the following ways:
99
99
100
-
- Click <imgsrc="/doc-assets/icons/settings.svg"className="inline-icon"alt="Settings icon" /> **Settings**. Copy the org ID in the top right corner. In the example below, the org ID is `axiom-abcd`.
- Click <imgsrc="/doc-assets/icons/settings.svg"className="inline-icon"alt="Settings icon" /> **Settings**, and then copy the org ID in the top right corner.
101
+
- Click <imgsrc="/doc-assets/icons/settings.svg"className="inline-icon"alt="Settings icon" /> **Settings > General**, and then find the **ID** section.
106
102
- Go to the [Axiom app](https://app.axiom.co/) and check the URL. For example, in the URL `https://app.axiom.co/axiom-abcd/datasets`, the org ID is `axiom-abcd`.
Features powered by Axiom AI allow you to get insights from your data faster. These features are powered by leading foundation models through trusted enterprise providers including Amazon Bedrock and Google Gemini. Your inputs and outputs are never used to train generative models.
2
+
3
+
AI features are turned on by default for most customers. You can turn them on or off anytime for the whole organization, for example, for regulatory and compliance reasons.
0 commit comments