mirror of
https://github.com/netdata/netdata.git
synced 2025-04-14 01:29:11 +00:00
Replace "XYZ view" with "XYZ tab" in documentation files (#14930)
* replace 'XYZ view' with 'XYZ tab' in documentation files * Update README.md
This commit is contained in:
Fotis Voutsas
GitHub
parent
103f00c5cc
commit
fadd2d81a9
14 changed files with 29 additions and 70 deletions
claim
docs
category-overview-pages
cloud
glossary.mdmonitor
quickstart
visualize
exporting/graphite
packaging
|
|
@ -36,7 +36,7 @@ There will be three main flows from where you might want to connect a node to Ne
|
|||
|
||||
- when you are on a [War Room](#empty-war-room) and you want to connect your first node
|
||||
- when you are at the [Manage Space](#manage-space-or-war-room) area and you select **Connect Nodes** to connect a node, coming from Manage Space or Manage War Room
|
||||
- when you are on the [Nodes view page](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) and want to connect a node - this process falls into the [Manage Space](#manage-space-or-war-room) flow
|
||||
- when you are on the [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) and want to connect a node - this process falls into the [Manage Space](#manage-space-or-war-room) flow
|
||||
|
||||
Please note that only the administrators of a Space in Netdata Cloud can view the claiming token and accompanying script, generated by Netdata Cloud, to trigger the connection process.
|
||||
|
||||
|
|
@ -62,7 +62,7 @@ finished onboarding.
|
|||
To connect a node, select which War Rooms you want to add this node to with the dropdown, then copy and paste the script
|
||||
given by Netdata Cloud into your node's terminal.
|
||||
|
||||
When coming from [Nodes view page](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) the room parameter is already defined to current War Room.
|
||||
When coming from the [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) the room parameter is already defined to current War Room.
|
||||
|
||||
### Connect an agent running in Linux
|
||||
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ that align with your goals and your organization's standards.
|
|||
## Disable the local dashboard
|
||||
|
||||
This is the _recommended method for those who have connected their nodes to Netdata Cloud_ and prefer viewing real-time
|
||||
metrics using the War Room Overview, Nodes view, and Cloud dashboards.
|
||||
metrics using the War Room Overview, Nodes tab, and Cloud dashboards.
|
||||
|
||||
You can disable the local dashboard (and API) but retain the encrypted Agent-Cloud link
|
||||
([ACLK](https://github.com/netdata/netdata/blob/master/aclk/README.md)) that
|
||||
|
|
|
|||
|
|
@ -1,14 +1,3 @@
|
|||
<!--
|
||||
title: "Run-time troubleshooting with Functions"
|
||||
sidebar_label: "Run-time troubleshooting with Functions"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/runtime-troubleshooting-with-functions.md"
|
||||
learn_status: "Published"
|
||||
sidebar_position: "4"
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "Operations"
|
||||
learn_docs_purpose: "Instructions on how to use Functions"
|
||||
-->
|
||||
|
||||
# Run-time troubleshooting with Functions
|
||||
|
||||
Netdata Functions feature allows you to execute on-demand a pre-defined routine on a node where a Netdata Agent is running. These routines are exposed by a given collector.
|
||||
|
|
@ -21,14 +10,14 @@ The following is required to be able to run Functions from Netdata Cloud.
|
|||
* At least one of the nodes claimed to your Space should be on a Netdata agent version higher than `v1.37.1`
|
||||
* Ensure that the node has the collector that exposes the function you want enabled ([see current available functions](https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-functions.md#what-functions-are-currently-available))
|
||||
|
||||
### Execute a function (from functions view)
|
||||
### Execute a function (from the Functions tab)
|
||||
|
||||
1. From the right-hand bar select the **Function** you want to run
|
||||
2. Still on the right-hand bar select the **Node** where you want to run it
|
||||
3. Results will be displayed in the central area for you to interact with
|
||||
4. Additional filtering capabilities, depending on the function, should be available on right-hand bar
|
||||
|
||||
### Execute a function (from Nodes view)
|
||||
### Execute a function (from the Nodes tab)
|
||||
|
||||
1. Click on the functions icon for a node that has this active
|
||||
2. You are directed to the **Functions** tab
|
||||
|
|
|
|||
|
|
@ -1,15 +1,3 @@
|
|||
<!--
|
||||
title: "Build new dashboards"
|
||||
description: >-
|
||||
"Design new dashboards that target your infrastructure's unique needs and share them with your team for
|
||||
targeted visual anomaly detection or incident response."
|
||||
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md"
|
||||
sidebar_label: "Build new dashboards"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
learn_rel_path: "Operations/Visualizations"
|
||||
-->
|
||||
|
||||
# Build new dashboards
|
||||
|
||||
With Netdata Cloud, you can build new dashboards that target your infrastructure's unique needs. Put key metrics from
|
||||
|
|
@ -82,7 +70,7 @@ dashboards.
|
|||
## Pin dashboards
|
||||
|
||||
Click on the **Pin** button in any dashboard to put those charts into a separate panel at the bottom of the screen. You
|
||||
can now navigate through Netdata Cloud freely, individual Cloud dashboards, the Nodes view, different War Rooms, or even
|
||||
can now navigate through Netdata Cloud freely, individual Cloud dashboards, the Nodes tab, different War Rooms, or even
|
||||
different Spaces, and have those valuable metrics follow you.
|
||||
|
||||
Pinning dashboards helps you correlate potentially related charts across your infrastructure, no matter how you
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ These charts provide a lot of useful information, so that you can:
|
|||
- Get the chart status and possible errors. On top, reload functionality
|
||||
|
||||
These charts are available on Netdata Cloud's
|
||||
[Overview tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md), Single Node view and
|
||||
[Overview tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md), Single Node tab and
|
||||
on your [Custom Dashboards](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md).
|
||||
|
||||
Some of the features listed below are also available on the simpler charts that are available on each agent's user interface.
|
||||
|
|
@ -29,7 +29,7 @@ Some of the features listed below are also available on the simpler charts that
|
|||
|
||||
Have a look at the can see the overall look and feel of the charts for both with a composite chart from
|
||||
the [Overview tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md) and a simple chart
|
||||
from the single node view:
|
||||
from the Single Node tab:
|
||||
|
||||
<img width="678" alt="image" src="https://user-images.githubusercontent.com/43294513/220913360-f3f2ac06-b715-4e99-a933-f3bcb776636f.png"/>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
# Nodes view
|
||||
# Nodes tab
|
||||
|
||||
The Nodes view lets you see and customize key metrics from any number of Agent-monitored nodes and seamlessly navigate
|
||||
The Nodes tab lets you see and customize key metrics from any number of Agent-monitored nodes and seamlessly navigate
|
||||
to any node's dashboard for troubleshooting performance issues or anomalies using Netdata's highly-granular metrics.
|
||||
|
||||
|
||||
|
||||
Each War Room's Nodes view is populated based on the nodes you added to that specific War Room. Each node occupies a
|
||||
Each War Room's Nodes tab is populated based on the nodes you added to that specific War Room. Each node occupies a
|
||||
single row, first featuring that node's alarm status (yellow for warnings, red for critical alarms) and operating
|
||||
system, some essential information about the node, followed by columns of user-defined key metrics represented in
|
||||
real-time charts.
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@ Click on the gear icon of the War Room's name in the top of the page to do that.
|
|||
|
||||
### More actions
|
||||
|
||||
To **view or remove nodes** in a War Room, click on **Nodes view**. To remove a node from the current War Room, click on
|
||||
To **view or remove nodes** in a War Room, click on the **Nodes tab**. To remove a node from the current War Room, click on
|
||||
the **🗑** icon.
|
||||
|
||||
> ### Info
|
||||
|
|
|
|||
|
|
@ -91,7 +91,7 @@ Use the alphabatized list below to find the answer to your single-term questions
|
|||
|
||||
- [**Kickstart** or **Kickstart Script**](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md): An automatic one-line installation script named 'kickstart.sh' that works on all Linux distributions and macOS.
|
||||
|
||||
- [**Kubernetes Dashboard** or **Kubernetes View**](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md): Netdata Cloud features enhanced visualizations for the resource utilization of Kubernetes (k8s) clusters, embedded in the default Overview dashboard.
|
||||
- [**Kubernetes Dashboard** or **Kubernetes Tab**](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md): Netdata Cloud features enhanced visualizations for the resource utilization of Kubernetes (k8s) clusters, embedded in the default Overview dashboard.
|
||||
|
||||
## M
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ You can always sort the table by a certain column by clicking on the name of tha
|
|||
|
||||
## Filter alerts
|
||||
|
||||
From this view, you can also filter alerts with the right hand bar. More specifically you can filter:
|
||||
From this tab, you can also filter alerts with the right hand bar. More specifically you can filter:
|
||||
|
||||
- Alert status
|
||||
- Filter based on the status of the alerts (e.g. Warning, Critical)
|
||||
|
|
|
|||
|
|
@ -68,10 +68,10 @@ These tabs can be separated into "static", meaning they are by default presented
|
|||
|
||||
#### Static tabs
|
||||
|
||||
- The default view for any War Room is the [Home tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md#home), which gives you an overview of this Space.
|
||||
- The default tab for any War Room is the [Home tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md#home), which gives you an overview of this Space.
|
||||
Here you can see the number of Nodes claimed, data retention statics, users by role, alerts and more.
|
||||
|
||||
- The second and most important view is the [Overview tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md#overview-and-single-node-view) which uses composite charts to display real-time metrics from every available node in a given War Room.
|
||||
- The second and most important tab is the [Overview tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md#overview-and-single-node-view) which uses composite charts to display real-time metrics from every available node in a given War Room.
|
||||
|
||||
- The [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) gives you the ability to see the status (offline or online), host details, alarm status and also a short overview of some key metrics from all your nodes at a glance.
|
||||
|
||||
|
|
@ -95,7 +95,7 @@ Tabs can be rearranged with drag-and-drop or closed with the **X** button. Open
|
|||
|
||||
### Drill down to specific nodes
|
||||
|
||||
Both the Overview and Nodes view offer easy access to **single-node dashboards** for targeted analysis. You can use
|
||||
Both the Overview and the Nodes tab offer easy access to **single-node dashboards** for targeted analysis. You can use
|
||||
single-node dashboards in Netdata Cloud to drill down on specific issues, scrub backward in time to investigate
|
||||
historical data, and see like metrics presented meaningfully to help you troubleshoot performance problems.
|
||||
|
||||
|
|
@ -173,7 +173,7 @@ collect from across your infrastructure with Netdata.
|
|||
title="Dashboards">
|
||||
<BoxList>
|
||||
<BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md)" title="Overview" />
|
||||
<BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md)" title="Nodes view" />
|
||||
<BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md)" title="Nodes tab" />
|
||||
<BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md)" title="Kubernetes" />
|
||||
<BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md)" title="Create new dashboards" />
|
||||
</BoxList>
|
||||
|
|
@ -208,7 +208,7 @@ collect from across your infrastructure with Netdata.
|
|||
- [War Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md)
|
||||
- Dashboards
|
||||
- [Overview](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md)
|
||||
- [Nodes view](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md)
|
||||
- [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md)
|
||||
- [Kubernetes](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md)
|
||||
- [Create new dashboards](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md)
|
||||
- Alerts and notifications
|
||||
|
|
|
|||
|
|
@ -87,9 +87,9 @@ investigate historical data, and see like metrics presented meaningfully to help
|
|||
All of the familiar [interactions](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md) are available, as is adding any chart
|
||||
to a [new dashboard](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md).
|
||||
|
||||
## Nodes view
|
||||
## Nodes tab
|
||||
|
||||
You can also use the **Nodes view** to monitor the health status and user-configurable key metrics from multiple nodes
|
||||
in a War Room. Read the [Nodes view doc](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) for details.
|
||||
You can also use the **Nodes tab** to monitor the health status and user-configurable key metrics from multiple nodes
|
||||
in a War Room. Read the [Nodes tab documentation](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) for details.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,3 @@
|
|||
<!--
|
||||
title: "Export metrics to Graphite providers"
|
||||
description: "Archive your Agent's metrics to a any Graphite database provider for long-term storage, further analysis, or correlation with data from other sources."
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/graphite/README.md"
|
||||
sidebar_label: "Graphite"
|
||||
learn_status: "Published"
|
||||
learn_rel_path: "Integrations/Export"
|
||||
-->
|
||||
|
||||
# Export metrics to Graphite providers
|
||||
|
||||
You can use the Graphite connector for
|
||||
|
|
@ -121,7 +112,7 @@ exporting charts to your Graphite dashboard!
|
|||
You can also show these exporting engine metrics on Netdata Cloud. If you don't have an account already,
|
||||
go [sign in](https://app.netdata.cloud) and get started for free.
|
||||
|
||||
Add more metrics to a War Room's Nodes view by clicking on the **Add metric** button, then typing `exporting` into the
|
||||
Add more metrics to a War Room's Nodes tab by clicking on the **Add metric** button, then typing `exporting` into the
|
||||
context field. Choose the exporting contexts you want to add, then click **Add**. You'll see these charts alongside any
|
||||
others you've customized in Netdata Cloud.
|
||||
|
||||
|
|
|
|||
|
|
@ -63,9 +63,9 @@ docker run -d --name=netdata \
|
|||
netdata/netdata
|
||||
```
|
||||
|
||||
> :bookmark_tabs: Note
|
||||
> ### Note
|
||||
>
|
||||
> If you plan to Claim the node to Netdata Cloud, you can find the command with the right parameters by clicking the "Add Nodes" button in your Space's "Nodes" view.
|
||||
> If you plan to Claim the node to Netdata Cloud, you can find the command with the right parameters by clicking the "Add Nodes" button in your Space's Nodes tab.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="docker compose" label="docker-compose">
|
||||
|
|
|
|||
|
|
@ -1,12 +1,3 @@
|
|||
<!--
|
||||
title: "Install Netdata on Kubernetes"
|
||||
description: "Deploy Netdata to monitor a Kubernetes cluster to monitor the health, performance, resource utilization, and application metrics of a Kubernetes cluster in real time."
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/kubernetes.md"
|
||||
sidebar_label: "Kubernetes"
|
||||
learn_status: "Published"
|
||||
learn_rel_path: "Installation/Install on specific environments"
|
||||
-->
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
|
|
@ -54,9 +45,9 @@ The installation process securely connects your Kubernetes cluster to stream met
|
|||
helm install netdata netdata/netdata
|
||||
```
|
||||
|
||||
> :bookmark_tabs: Note
|
||||
> ### Note
|
||||
>
|
||||
> If you plan to connect the node to Netdata Cloud, you can find the command with the right parameters by clicking the "Add Nodes" button in your Space's "Nodes" view.
|
||||
> If you plan to connect the node to Netdata Cloud, you can find the command with the right parameters by clicking the "Add Nodes" button in your Space's Nodes tab.
|
||||
|
||||
For more installation options, please read our [Netdata Helm chart for Kubernetes](https://github.com/netdata/helmchart/blob/master/charts/netdata/README.md) reference.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue