Skip to content

Commit c0c0623

Browse files
authored
Merge branch 'main' into fix-3214-create-dashboard
2 parents c9de035 + 3fcfb99 commit c0c0623

File tree

97 files changed

+488
-252
lines changed

Some content is hidden

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

97 files changed

+488
-252
lines changed

deploy-manage/cloud-organization/tools-and-apis.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ You can use the [{{ecloud}} API](https://www.elastic.co/docs/api/doc/cloud/) to
1313
* Refer to [](/deploy-manage/api-keys/elastic-cloud-api-keys.md) to learn how to generate an API key to access this API.
1414
* Refer to [{{ecloud}} RESTful API](cloud://reference/cloud-hosted/ec-api-restful.md) for usage information and examples.
1515

16+
For additional billing and cost information for {{ecloud}}, you can use the [Cloud Billing API](https://www.elastic.co/docs/api/doc/cloud-billing/).
17+
1618
For {{ecloud}} [service status](/deploy-manage/cloud-organization/service-status.md) updates, you can use the [Service Status API](https://status.elastic.co/api/).
1719

1820
For information about all of the tools and APIs that you can use to manage your {{ech}} deployments and {{serverless-full}} projects, refer to [](/deploy-manage/deploy/elastic-cloud/tools-apis.md).

deploy-manage/deploy/elastic-cloud/tools-apis.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ The following REST APIs allow you to manage your {{ecloud}} organization, users,
3333
| {{ecloud}} organization<br><br>{{ech}} deployments | [{{ecloud}} API](https://www.elastic.co/docs/api/doc/cloud/) | Manage your Cloud organization, members, costs, billing, and more.<br><br>Manage your hosted deployments and all of the resources associated with them, including scaling or autoscaling resources, and managing network security, deployment extensions, remote clusters, and {{stack}} versions.<br><br>Refer to [{{ecloud}} RESTful API](cloud://reference/cloud-hosted/ec-api-restful.md) for usage information and examples. |
3434
| {{serverless-full}} projects | [{{serverless-full}} API](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless) | Manage {{serverless-full}} projects. |
3535
| {{ecloud}} services | [Service Status API](https://status.elastic.co/api/) | Programmatically ingest [service status](/deploy-manage/cloud-organization/service-status.md) updates. |
36+
| {{ecloud}} billing information | [Cloud Billing API](https://www.elastic.co/docs/api/doc/cloud-billing/) | Retrieve additional billing and cost information about your {{ecloud}} organization. |
3637

3738

3839
### APIs to interact with data and solution features

deploy-manage/security/private-connectivity-aws.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ If the policy doesn't contain a VPC filter, then the association can serve as a
301301
302302
## Access the deployment over a PrivateLink [ec-access-the-deployment-over-private-link]
303303
304-
For traffic to connect with the deployment over Azure PrivateLink, the client making the request needs to be located within the VPC where you’ve created the VPC endpoint. You can also set up network traffic to flow through the originating VPC from somewhere else, such as another VPC or VPN from your corporate network. This assumes that the VPC endpoint and the DNS record are also available within that context. Check your service provider documentation for setup instructions.
304+
For traffic to connect with the deployment over AWS PrivateLink, the client making the request needs to be located within the VPC where you’ve created the VPC endpoint. You can also set up network traffic to flow through the originating VPC from somewhere else, such as another VPC or VPN from your corporate network. This assumes that the VPC endpoint and the DNS record are also available within that context. Check your service provider documentation for setup instructions.
305305
306306
::::{important}
307307
Use the alias you’ve set up as CNAME DNS record to access your deployment.
@@ -408,4 +408,4 @@ To delete a policy:
408408
409409
:::{include} _snippets/network-security-page.md
410410
:::
411-
4. Find the policy you want to edit, then click the **Delete** icon. The icon is inactive if there are deployments associated with the policy.
411+
4. Find the policy you want to edit, then click the **Delete** icon. The icon is inactive if there are deployments associated with the policy.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
To add a Discover query to a dashboard in a way that preserves the [controls created from Discover](/explore-analyze/discover/try-esql.md#add-variable-control-discover) and also adds them to the dashboard, do as follows:
2+
3+
1. Save the {{esql}} query containing the variable control into a Discover session. If your Discover session contains several tabs, only the first tab will be imported to the dashboard.
4+
5+
1. Go to **Dashboards** and open or create one.
6+
7+
1. Select **Add**, then **From library**.
8+
9+
1. Find and select the Discover session you saved earlier.
10+
11+
A new panel appears on the dashboard with the results of the query along with any attached controls.
12+
13+
![Importing Discover controls into a dashboard](/explore-analyze/images/import-discover-control-dashboard.png " =40%")
14+
15+
:::{note}
16+
When you add a visualization to a dashboard using the {icon}`save` **Save visualization** option, controls are not added to the dashboard.
17+
:::
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
**Examples**
2+
3+
* Integrate filtering into your {{esql}} experience
4+
5+
```esql
6+
| WHERE field == ?value
7+
```
8+
9+
* Fields in controls for dynamic group by
10+
11+
```esql
12+
| STATS count=COUNT(*) BY ??field
13+
```
14+
15+
* Variable time ranges? Bind function configuration settings to a control
16+
17+
```esql
18+
| BUCKET(@timestamp, ?interval),
19+
```
20+
21+
* Make the function itself dynamic
22+
23+
```esql
24+
| STATS metric = ??function
25+
```
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
* The type of the control.
2+
* For controls with **Static values**, enter available controls manually or select them from the dropdown list.
3+
* For controls with **Values from a query**, write an {{esql}} query to populate the list of options.
4+
* The name of the control. This name is used to reference the control in {{esql}} queries.
5+
* Start the name with `?` if you want the options to be simple static values.
6+
* {applies_to}`stack: ga 9.1` Start the name with `??` if you want the options to be fields or functions.
7+
* The values users can select for this control. You can add multiple values from suggested fields, or type in custom values. If you selected **Values from a query**, you must instead write an {{esql}} query at this step.
8+
* The label of the control. This is the label displayed in **Discover** or in the dashboard.
9+
* The width of the control.
10+
11+
![ESQL control settings](/explore-analyze/images/esql-visualization-control-settings.png "title =50%")

explore-analyze/alerts-cases/watcher/schedule-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,7 @@ By default, the `yearly` schedule is evaluated in the UTC time zone. To use a di
422422
## {{watcher}} cron schedule [schedule-cron]
423423

424424

425-
Defines a [`schedule`](trigger-schedule.md) using a [cron expression](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#api-cron-expressions) that specifiues when to execute a watch.
425+
Defines a [`schedule`](trigger-schedule.md) using a [cron expression](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#api-cron-expressions) that specifies when to execute a watch.
426426

427427
::::{tip}
428428
While cron expressions are powerful, a regularly occurring schedule is easier to configure with the other schedule types. If you must use a cron schedule, make sure you verify it with [`elasticsearch-croneval`](elasticsearch://reference/elasticsearch/command-line-tools/elasticsearch-croneval.md) .

explore-analyze/dashboards/add-controls.md

Lines changed: 16 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,10 @@ You can add one interactive time slider control to a dashboard.
9090

9191

9292
## Add variable controls [add-variable-control]
93+
```{applies_to}
94+
stack: preview 9.0
95+
serverless: preview
96+
```
9397

9498
:::{note}
9599
In versions `9.0` and `9.1`, variable controls are called {{esql}} controls.
@@ -113,17 +117,8 @@ Only **Options lists** are supported for {{esql}}-based controls. Options can be
113117

114118
2. A menu opens to let you configure the control. This is where you can specify:
115119

116-
* The type of the control.
117-
* For controls with **Static values**, select the options available in the controls by entering them manually or by using a dropdown listing available values.
118-
* For controls with **Values from a query**, write an {{esql}} query to populate the list of options.
119-
* The name of the control. This name is used to reference the control in {{esql}} queries.
120-
* Start the name with `?` if you want the options to be simple static values.
121-
* Start the name with `??` if you want the options of the control to be fields or functions. {applies_to}`stack: ga 9.1`
122-
* The values users can select for this control. You can add multiple values from suggested fields, or type in custom values. If you selected **Values from a query**, you must instead write an {{esql}} query at this step.
123-
* The label of the control. This is the label displayed for users viewing the dashboard for that control.
124-
* The width of the control.
125-
126-
![ESQL control settings](/explore-analyze/images/esql-visualization-control-settings.png "title =50%")
120+
:::{include} ../_snippets/variable-control-form.md
121+
:::
127122

128123
3. Save the control.
129124

@@ -132,34 +127,19 @@ If you added it by starting from a query, the control is directly inserted in th
132127

133128
You can then insert it in any other {{esql}} visualization queries by typing the control's name.
134129

130+
:::{include} ../_snippets/variable-control-examples.md
131+
:::
135132

136-
**Examples**
137-
138-
* Integrate filtering into your {{esql}} experience
139-
140-
```esql
141-
| WHERE field == ?value
142-
```
143-
144-
* Fields in controls for dynamic group by
145-
146-
```esql
147-
| STATS count=COUNT(*) BY ?field
148-
```
149-
150-
* Variable time ranges? Bind function configuration settings to a control
151-
152-
```esql
153-
| BUCKET(@timestamp, ?interval),
154-
```
155-
156-
* Make the function itself dynamic
133+
![Editing {{esql}} controls from a dashboard](https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blte42dfaa404bfc2d6/67d2e31e2e4dc59da190d78f/dashboard-esql-controls.gif)
157134

158-
```esql
159-
| STATS metric = ?function
160-
```
135+
### Import a Discover query along with its controls into a dashboard
136+
```{applies_to}
137+
stack: preview 9.2
138+
serverless: preview
139+
```
161140

162-
![Editing {{esql}} controls from a dashboard](https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blte42dfaa404bfc2d6/67d2e31e2e4dc59da190d78f/dashboard-esql-controls.gif)
141+
:::{include} ../_snippets/import-discover-query-controls-into-dashboard.md
142+
:::
163143

164144
## Configure the controls settings [configure-controls-settings]
165145

explore-analyze/dashboards/arrange-panels.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Organize your dashboard panels into collapsible sections to improve readability
2323
To add a collapsible section:
2424

2525
1. Open the dashboard and make sure that you are in **Edit** mode.
26-
2. Select **Add panel** and select **Collapsible section**. The collapsible section is added at the end of the dashboard.
26+
2. Add a new panel and select **Collapsible section**. The collapsible section is added at the end of the dashboard.
2727
3. Optionally, edit the label of the section.
2828
4. Drag and drop any panels you want into the section.
2929
:::{tip}

explore-analyze/dashboards/duplicate-dashboards.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ products:
1111
# Duplicate a dashboard [duplicate-dashboards]
1212

1313
1. Open the dashboard you want to duplicate.
14-
2. In **View** mode, click **Duplicate** in the toolbar.
14+
2. Exit the edit mode, and click **Duplicate** in the toolbar.
1515
3. In the **Duplicate dashboard** window, enter a title and optional description and tags.
1616
4. Click **Save**.
1717

0 commit comments

Comments
 (0)