upd notebooks overview and troubleshoot notebooks
parent
bd3b6e1c90
commit
a6cbf318e4
|
@ -10,72 +10,67 @@ menu:
|
|||
parent: Notebooks
|
||||
---
|
||||
|
||||
Learn about the building blocks of a notebook, how notebooks can help show how data is processed, and discover some common use cases.
|
||||
Learn how notebooks can help to streamline and simplify your day-to-day business processes.
|
||||
|
||||
To use different notebook cell types, controls, and uses to process data, see:
|
||||
- [Notebook concepts](/influxdb/v2.1/notebooks/overview/#notebook-concepts)
|
||||
- [Notebook controls](/influxdb/v2.1/notebooks/overview/#notebook-controls)
|
||||
- [Notebook cell types](/influxdb/v2.1/notebooks/overview/#notebook-cell-types)
|
||||
See an overview of [notebook concepts](/influxdb/v2.1/notebooks/overview/#notebook-concepts), [notebook controls](/influxdb/v2.1/notebooks/overview/#notebook-controls), and [notebook cell types](/influxdb/v2.1/notebooks/overview/#notebook-cell-types) also know as the basic building blocks of a notebook.
|
||||
|
||||
## Notebook concepts
|
||||
|
||||
Using notebooks, you can:
|
||||
You can think of an InfluxDB notebook as template that contains cells (building blocks) to define how to query, visualize, process, and write data to your buckets. Notebooks help you do the following:
|
||||
|
||||
- Create documents with live code, equations, visualizations, and explanatory notes.
|
||||
- Create dashboard cells or scheduled tasks.
|
||||
- Clean and downsample data.
|
||||
- Build runbooks.
|
||||
- Document data processing steps.
|
||||
- Create snippets of live code, equations, visualizations, and explanatory notes.
|
||||
- Create alerts or scheduled tasks.
|
||||
- Downsample and normalize data.
|
||||
- Build runbooks to share with your teams.
|
||||
- Output data to buckets.
|
||||
|
||||
## Notebook controls
|
||||
|
||||
The following options appear at the top of each notebook.
|
||||
|
||||
### Preview/Run mode
|
||||
### Run
|
||||
|
||||
- Select **Preview** (or press **Control+Enter**) to display results of each cell without writing data. Helps to verify that cells return expected results before writing data.
|
||||
- Select **Run** mode displays results of each cell and writes data to the selected bucket.
|
||||
Select {{< caps >}}Run{{< /caps >}} (or press **Control+Enter**) to display results of each cell and write data to the selected bucket.
|
||||
|
||||
### Presentation mode
|
||||
### Save Notebook
|
||||
|
||||
Display notebooks in full screen with Presentation mode, hiding the left and top navigation menus so only the cells appear. This mode might be helpful, for example, for stationary screens dedicated to monitoring visualizations.
|
||||
Select {{< caps >}}Save Notebook{{< /caps >}} to save all notebook cells.
|
||||
|
||||
{{% note %}}
|
||||
Saving the notebook does not save cell results. When you open a saved notebook, click {{< caps >}}**Run**{{< /caps >}} to update cell results. {{% /note %}}
|
||||
|
||||
### Local or UTC timezone
|
||||
|
||||
Click the timezone dropdown list to select a timezone to use for the dashboard. Select either the local time (default) or UTC.
|
||||
Click the timezone dropdown list to select a timezone to use for the notebook. Select either the local time (default) or UTC.
|
||||
|
||||
### Time range
|
||||
|
||||
Select from the options in the dropdown list or select **Custom Time Range** to enter a custom time range with precision up to nanoseconds.
|
||||
Select from the options in the dropdown list or select **Custom Time Range** to enter a custom time range with precision up to nanoseconds, and then click {{< caps >}}Apply Time Range{{< /caps >}}.
|
||||
|
||||
## Notebook cell types
|
||||
|
||||
The following cell types are available for your notebook:
|
||||
- [Data source](#data-source)
|
||||
- [Visualization](#visualization)
|
||||
- [Actions](#actions)
|
||||
- [Action](#action)
|
||||
|
||||
### Data source
|
||||
|
||||
At least one input cell is required in a notebook for other cells to run.
|
||||
At least one data source (input) cell is required in a notebook for other cells to run.
|
||||
|
||||
- **Flux Script**: Input your data using a Flux script.
|
||||
- **Query Builder**: Input your data using a query.
|
||||
- {{< caps >}}Query Builder{{< /caps >}}: Input your data using a query.
|
||||
- {{< caps >}}Flux Script{{< /caps >}}: Input your data using a Flux script.
|
||||
|
||||
Data source cells work like the **Query Builder** or **Script Editor** in Data Explorer. For more information, see how to [query data with Flux and the Data Explorer](/influxdb/v2.1/query-data/execute-queries/data-explorer/#query-data-with-flux-and-the-data-explorer).
|
||||
|
||||
### Visualization
|
||||
|
||||
- **Table**: View your data in a table.
|
||||
- **Graph**: View your data in a graph.
|
||||
- **Note**: Create explanatory notes or other information for yourself or one of your team members.
|
||||
- {{< caps >}}Table{{< /caps >}}: View your data in a table.
|
||||
- {{< caps >}}Graph{{< /caps >}}: View your data in a graph.
|
||||
- {{< caps >}}Note{{< /caps >}}: Create explanatory notes or other information for yourself or one of your team members.
|
||||
|
||||
### Action
|
||||
|
||||
- **Column Editor**: Modify column visibility and naming.
|
||||
- **Markdown**: Create explanatory notes or other information for yourself or one of your team members.
|
||||
- **Visualization**: Represents your data in visual formats such as graphs or charts.
|
||||
|
||||
### Output
|
||||
|
||||
- **Alert**: Set up alerts. See how to [monitor data and send alerts](https://docs.influxdata.com/influxdb/v2.0/monitor-alert/).
|
||||
- **Tasks**: Set up tasks. See how to [manage tasks in InfluxDB] (https://docs.influxdata.com/influxdb/v2.0/process-data/manage-tasks/).
|
||||
- **Output to Bucket**: In **Preview** mode, this cell represents what would be written if the data was going to be committed to a bucket. In **Run** mode, this writes data to the specified bucket.
|
||||
- {{< caps >}}Alert{{< /caps >}}: Set up alerts. See how to [monitor data and send alerts](/influxdb/v2.1/monitor-alert/).
|
||||
- {{< caps >}}Tasks{{< /caps >}}: Set up tasks. See how to [manage tasks in InfluxDB](/influxdb/v2.1/process-data/manage-tasks/).
|
||||
When an action is processed, the alert or task results are written to the specified bucket as applicable.
|
||||
|
|
|
@ -10,10 +10,13 @@ menu:
|
|||
---
|
||||
|
||||
### No measurements appear in my bucket even though there's data in it.
|
||||
|
||||
Try changing the time range. You might have measurements prior to the time range you selected. For example, if the selected time range is `Past 1h` and the last write happened 16 hours ago, you'd need to change the time range to `Past 24h` (or more) to see your data.
|
||||
|
||||
### "No bucket exists" error message appears.
|
||||
This error appears when the Buckets API endpoint returns a list of bucket and you don’t have access to that bucket. Verify that you have access permissions to the bucket that you're trying to query or write to.
|
||||
|
||||
### Metric selector crashes.
|
||||
This error occurs when the [Buckets API endpoint](/influxdb/v2.1/api/#tag/Buckets) returns a list of bucket and you don’t have access to that bucket. Verify that you have access permissions to the bucket that you're trying to query or write to.
|
||||
|
||||
### My notebook crashes or is running slowly.
|
||||
|
||||
This can occur with high-cardinality buckets when there's too much data for the browser. To decrease the amount of data in your bucket, see how to [resolve high series cardinality](/influxdb/v2.1/write-data/best-practices/resolve-high-cardinality/).
|
||||
|
|
|
@ -41,8 +41,8 @@ See [Get started with Flux](/influxdb/v2.1/query-data/get-started) to learn more
|
|||
5. Click **Submit** (or press `Control+Enter`) to run your query. You can then preview your graph in the above pane.
|
||||
To cancel your query while it's running, click **Cancel**.
|
||||
6. To work on multiple queries at once, click the {{< icon "plus" >}} to add another tab.
|
||||
* Click the eye icon on a tab to hide or show a query's visualization.
|
||||
* Click the name of the query in the tab to rename it.
|
||||
- Click the eye icon on a tab to hide or show a query's visualization.
|
||||
- Click the name of the query in the tab to rename it.
|
||||
|
||||
## Visualize your query
|
||||
|
||||
|
|
Loading…
Reference in New Issue