Jts/obsolete monitor enterprise with cloud (#6453)
* chore(ent1): Remove monitor Enterprise with Cloud guide:- Removes content/enterprise_influxdb/v1/administration/monitor/monitor-with-cloud.md - Add aliases in monitor/_index.md- Verified no other pages link to it * chore(platform): Update /platform for InfluxDB 3 - Add InfluxDB 3 section highlighting Core, Enterprise, Cloud products - Add Telegraf section with InfluxDB 3 support - Update monitoring guide to emphasize InfluxDB 3 with built-in processing - Remove obsolete install/deploy guides (AWS, GCP, Kubernetes deployment) - Remove obsolete integration guides (Docker, Kubernetes) - Remove obsolete troubleshooting guides (HHQ, IOPS, log analysis, etc.) - Add aliases for all deleted pages to prevent 404s - Improve content clarity and reduce repetition Note: Additional cleanup and content improvements remain for follow-up * Update content/platform/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> --------- Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>docs/6292-api-distinct-cache-delete
Jason Stirnaman
GitHub
parent
e3a1305416
commit
19ed26a37c
|
|
@ -6,6 +6,9 @@ menu:
|
|||
name: Monitor
|
||||
parent: Administration
|
||||
weight: 50
|
||||
aliases:
|
||||
- /enterprise_influxdb/v1/administration/monitor-enterprise/monitor-with-cloud/
|
||||
- /enterprise_influxdb/v1/administration/monitor/monitor-with-cloud/
|
||||
---
|
||||
|
||||
Monitoring is the act of observing changes in data over time.
|
||||
|
|
|
|||
|
|
@ -1,185 +0,0 @@
|
|||
---
|
||||
title: Monitor InfluxDB Enterprise with InfluxDB Cloud
|
||||
description: >
|
||||
Monitor your InfluxDB Enterprise instance using InfluxDB Cloud and
|
||||
a pre-built InfluxDB template.
|
||||
menu:
|
||||
enterprise_influxdb_v1:
|
||||
name: Monitor with Cloud
|
||||
parent: Monitor
|
||||
weight: 100
|
||||
aliases:
|
||||
- /enterprise_influxdb/v1/administration/monitor-enterprise/monitor-with-cloud/
|
||||
---
|
||||
|
||||
Use [InfluxDB Cloud](/influxdb/cloud/), the [InfluxDB Enterprise 1.x Template](https://github.com/influxdata/community-templates/tree/master/influxdb-enterprise-1x), and Telegraf to monitor one or more InfluxDB Enterprise instances.
|
||||
|
||||
Do the following:
|
||||
|
||||
1. [Review requirements](#review-requirements)
|
||||
2. [Install the InfluxDB Enterprise Monitoring template](#install-the-influxdb-enterprise-monitoring-template)
|
||||
3. [Set up InfluxDB Enterprise for monitoring](#set-up-influxdb-enterprise-for-monitoring)
|
||||
4. [Set up Telegraf](#set-up-telegraf)
|
||||
5. [View the Monitoring dashboard](#view-the-monitoring-dashboard)
|
||||
6. (Optional) [Alert when metrics stop reporting](#alert-when-metrics-stop-reporting)
|
||||
7. (Optional) [Create a notification endpoint and rule](#create-a-notification-endpoint-and-rule)
|
||||
8. (Optional) [Monitor with InfluxDB Insights](#monitor-with-influxdb-insights)
|
||||
|
||||
## Review requirements
|
||||
|
||||
Before you begin, make sure you have access to the following:
|
||||
|
||||
- An InfluxDB Cloud account. ([Sign up for free here](https://cloud2.influxdata.com/signup)).
|
||||
- Command line access to a machine [running InfluxDB Enterprise 1.x](/enterprise_influxdb/v1/introduction/install-and-deploy/) and permissions to install Telegraf on this machine.
|
||||
- Internet connectivity from the machine running InfluxDB Enterprise 1.x and Telegraf to InfluxDB Cloud.
|
||||
- Sufficient resource availability to install the template. (InfluxDB Cloud Free Plan accounts include a finite number of [available resources](/influxdb/cloud/account-management/limits/#free-plan-limits).)
|
||||
|
||||
## Install the InfluxDB Enterprise Monitoring template
|
||||
|
||||
The InfluxDB Enterprise Monitoring template includes a Telegraf configuration that sends InfluxDB Enterprise metrics to an InfluxDB endpoint, and a dashboard that visualizes the metrics.
|
||||
|
||||
1. [Log into your InfluxDB Cloud account](https://cloud2.influxdata.com/), go to **Settings > Templates**, and enter the following template URL:
|
||||
|
||||
```
|
||||
https://raw.githubusercontent.com/influxdata/community-templates/master/influxdb-enterprise-1x/enterprise.yml
|
||||
```
|
||||
|
||||
2. Click **Lookup Template**, and then click **Install Template**. InfluxDB Cloud imports the template, which includes the following resources:
|
||||
- Telegraf Configuration `monitoring-enterprise-1x`
|
||||
- Dashboard `InfluxDB 1.x Enterprise`
|
||||
- Label `enterprise`
|
||||
- Variables `influxdb_host` and `bucket`
|
||||
|
||||
## Set up InfluxDB Enterprise for monitoring
|
||||
|
||||
By default, InfluxDB Enterprise 1.x has a `/metrics` endpoint available, which exports Prometheus-style system metrics.
|
||||
|
||||
1. Make sure the `/metrics` endpoint is [enabled](/influxdb/v2/reference/config-options/#metrics-disabled). If you've changed the default settings to disable the `/metrics` endpoint, [re-enable these settings](/influxdb/v2/reference/config-options/#metrics-disabled).
|
||||
2. Navigate to the `/metrics` endpoint of your InfluxDB Enterprise instance to view the InfluxDB Enterprise system metrics in your browser:
|
||||
|
||||
```
|
||||
http://localhost:8086/metrics
|
||||
```
|
||||
|
||||
Or use `curl` to fetch metrics:
|
||||
|
||||
```sh
|
||||
curl http://localhost:8086/metrics
|
||||
# HELP boltdb_reads_total Total number of boltdb reads
|
||||
# TYPE boltdb_reads_total counter
|
||||
boltdb_reads_total 41
|
||||
# HELP boltdb_writes_total Total number of boltdb writes
|
||||
# TYPE boltdb_writes_total counter
|
||||
boltdb_writes_total 28
|
||||
# HELP go_gc_duration_seconds A summary of the pause duration of garbage collection cycles.
|
||||
...
|
||||
```
|
||||
3. Add your **InfluxDB Cloud** account information (URL and organization) to your Telegraf configuration by doing the following:
|
||||
1. Go to **Load Data > Telegraf** [in your InfluxDB Cloud account](https://cloud2.influxdata.com/), and click **InfluxDB Output Plugin** at the top-right corner.
|
||||
2. Copy the `urls`, `token`, `organization`, and `bucket` and close the window.
|
||||
3. Click **monitoring-enterprise-1.x**.
|
||||
4. Replace `urls`, `token`, `organization`, and `bucket` under `outputs.influxdb_v2` with your InfluxDB Cloud account information. Alternatively, store this information in your environment variables and include the environment variables in your configuration.
|
||||
|
||||
{{% note %}}
|
||||
To ensure the InfluxDB Enterprise monitoring dashboard can display the recorded metrics, set the destination bucket name to `enterprise_metrics` in your `telegraf.conf`.
|
||||
{{% /note %}}
|
||||
|
||||
5. Add the [Prometheus input plugin](https://github.com/influxdata/telegraf/blob/release-1.19/plugins/inputs/prometheus/README.md) to your `telegraf.conf`. Specify your your InfluxDB Enterprise URL(s) in the `urls` parameter. For example:
|
||||
|
||||
{{< keep-url >}}
|
||||
```toml
|
||||
[[inputs.prometheus]]
|
||||
urls = ["http://localhost:8086/metrics"]
|
||||
username = "$INFLUX_USER"
|
||||
password = "$INFLUX_PASSWORD"
|
||||
```
|
||||
|
||||
If you're using unique URLs or have authentication set up for your `/metrics` endpoint, configure those options here and save the updated configuration.
|
||||
|
||||
For more information about customizing Telegraf, see [Configure Telegraf](/telegraf/v1/administration/configuration/#global-tags).
|
||||
4. Click **Save Changes**.
|
||||
|
||||
## Set up Telegraf
|
||||
|
||||
Set up Telegraf to scrape metrics from InfluxDB Enterprise to send to your InfluxDB Cloud account.
|
||||
|
||||
On each InfluxDB Enterprise instance you want to monitor, do the following:
|
||||
|
||||
1. Go to **Load Data > Telegraf** [in your InfluxDB Cloud account](https://cloud2.influxdata.com/).
|
||||
2. Click **Setup Instructions** under **monitoring-enterprise-1.x**.
|
||||
3. Complete the Telegraf Setup instructions. If you are using environment variables, set them up now.
|
||||
|
||||
{{% note %}}
|
||||
For your API token, generate a new token or use an existing All Access token. If you run Telegraf as a service, edit your init script to set the environment variable and ensure that it's available to the service.
|
||||
{{% /note %}}
|
||||
|
||||
Telegraf runs quietly in the background (no immediate output appears), and Telegraf begins pushing metrics to your InfluxDB Cloud account.
|
||||
|
||||
## View the Monitoring dashboard
|
||||
|
||||
To see your data in real time, view the Monitoring dashboard.
|
||||
|
||||
1. Select **Boards** (**Dashboards**) in your **InfluxDB Cloud** account.
|
||||
|
||||
{{< nav-icon "dashboards" >}}
|
||||
|
||||
2. Click **InfluxDB Enterprise Metrics**. Metrics appear in your dashboard.
|
||||
3. Customize your monitoring dashboard as needed. For example, send an alert in the following cases:
|
||||
- Users create a new task or bucket
|
||||
- You're testing machine limits
|
||||
- [Metrics stop reporting](#alert-when-metrics-stop-reporting)
|
||||
|
||||
## Alert when metrics stop reporting
|
||||
|
||||
The Monitoring template includes a [deadman check](/influxdb/cloud/monitor-alert/checks/create/#deadman-check) to verify metrics are reported at regular intervals.
|
||||
|
||||
To alert when data stops flowing from InfluxDB OSS instances to your InfluxDB Cloud account, do the following:
|
||||
|
||||
1. [Customize the deadman check](#customize-the-deadman-check) to identify the fields you want to monitor.
|
||||
2. [Create a notification endpoint and rule](#create-a-notification-endpoint-and-rule) to receive notifications when your deadman check is triggered.
|
||||
|
||||
### Customize the deadman check
|
||||
|
||||
1. To view the deadman check, click **Alerts** in the navigation bar of your **InfluxDB Cloud** account.
|
||||
|
||||
{{< nav-icon "alerts" >}}
|
||||
|
||||
2. Choose a InfluxDB OSS field or create a new OSS field for your deadman alert:
|
||||
1. Click **{{< icon "plus" "v2" >}} Create** and select **Deadman Check** in the dropown menu.
|
||||
2. Define your query with at least one field.
|
||||
3. Click **Submit** and **Configure Check**.
|
||||
When metrics stop reporting, you'll receive an alert.
|
||||
3. Start under **Schedule Every**, set the amount of time to check for data.
|
||||
4. Set the amount of time to wait before switching to a critical alert.
|
||||
5. Save the Check and click on **View History** of the Check under the gear icon to verify it is running.
|
||||
|
||||
## Create a notification endpoint and rule
|
||||
|
||||
To receive a notification message when your deadman check is triggered, create a [notification endpoint](#create-a-notification-endpoint) and [rule](#create-a-notification-rule).
|
||||
|
||||
### Create a notification endpoint
|
||||
|
||||
InfluxDB Cloud supports different endpoints: Slack, PagerDuty, and HTTP. Slack is free for all users, while PagerDuty and HTTP are exclusive to the Usage-Based Plan.
|
||||
|
||||
#### Send a notification to Slack
|
||||
|
||||
1. Create a [Slack Webhooks](https://api.slack.com/messaging/webhooks).
|
||||
2. Go to **Alerts > Notification Endpoint** and click **{{< icon "plus" "v2" >}} Create**, and enter a name and description for your Slack endpoint.
|
||||
3. Enter your Slack Webhook under **Incoming Webhook URL** and click **Create Notification Endpoint**.
|
||||
|
||||
#### Send a notification to PagerDuty or HTTP
|
||||
|
||||
Send a notification to PagerDuty or HTTP endpoints (other webhooks) by [upgrading your InfluxDB Cloud account](/influxdb/cloud/account-management/billing/#upgrade-to-usage-based-plan).
|
||||
|
||||
### Create a notification rule
|
||||
|
||||
[Create a notification rule](/influxdb/cloud/monitor-alert/notification-rules/create/) to set rules for when to send a deadman alert message to your notification endpoint.
|
||||
|
||||
1. Go to **Alerts > Notification Rules** and click **{{< icon "plus" "v2" >}} Create**.
|
||||
2. Fill out the **About** and **Conditions** section then click **Create Notification Rule**.
|
||||
|
||||
## Monitor with InfluxDB Insights
|
||||
|
||||
For InfluxDB Enterprise customers, Insights is a free service that monitors your cluster and sends metrics to a private Cloud account. This allows InfluxDB Support to monitor your cluster health and access usage statistics when assisting with support tickets that you raise.
|
||||
|
||||
To apply for this service, please [contact InfluxData support](https://support.influxdata.com).
|
||||
|
|
@ -14,7 +14,7 @@ aliases:
|
|||
- /enterprise_influxdb/v1/administration/monitor-enterprise/monitor-with-oss/
|
||||
---
|
||||
|
||||
Use [InfluxDB OSS](/influxdb/v2/), the [InfluxDB Enterprise 1.x Template](https://github.com/influxdata/community-templates/tree/master/influxdb-enterprise-1x), and Telegraf to monitor one or more InfluxDB Enterprise instances.
|
||||
Use [InfluxDB OSS 2.x](/influxdb/v2/), the [InfluxDB Enterprise 1.x Template](https://github.com/influxdata/community-templates/tree/master/influxdb-enterprise-1x), and Telegraf to monitor one or more InfluxDB Enterprise instances.
|
||||
|
||||
Do the following:
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: Troubleshoot systemd errors
|
|||
list_title: systemd permission errors
|
||||
description: Troubleshoot errors with InfluxDB and systemd permissions
|
||||
menu:
|
||||
platform:
|
||||
influxdb_v1:
|
||||
name: systemd errors
|
||||
parent: Troubleshoot
|
||||
weight: 1
|
||||
|
|
|
|||
|
|
@ -3,33 +3,69 @@ title: Introduction to the InfluxData platform
|
|||
description: The InfluxData platform is the leading modern time-series platform built for metrics and events.
|
||||
aliases:
|
||||
- /platform/introduction
|
||||
- /platform/integrations/
|
||||
- /platform/integrations/docker/
|
||||
- /platform/integrations/kubernetes/
|
||||
- /platform/ops-guide/
|
||||
- /platform/install-and-deploy/
|
||||
- /platform/install-and-deploy/deploying/
|
||||
- /platform/install-and-deploy/deploying/amazon-web-services/
|
||||
- /platform/install-and-deploy/deploying/google-cloud-platform/
|
||||
- /platform/install-and-deploy/deploying/kubernetes/
|
||||
- /platform/install-and-deploy/deploying/sandbox-install/
|
||||
menu:
|
||||
platform:
|
||||
name: Introduction
|
||||
weight: 1
|
||||
---
|
||||
|
||||
**InfluxData platform** is the leading modern [time series](/platform/faq/#what-is-time-series-data) platform, built for metrics and events. Explore both versions of our platform below--[**InfluxDB 2.0**](#influxdb-2-0) and [**InfluxData 1.x**](#influxdata-1-x).
|
||||
**InfluxData platform** is the leading modern [time series](/platform/faq/#what-is-time-series-data) platform, built for metrics and events.
|
||||
|
||||
## InfluxDB 2.0
|
||||
## InfluxDB 3
|
||||
|
||||
The **InfluxDB 2.0 platform** consolidates InfluxDB, Chronograf, and Kapacitor from the **InfluxData 1.x platform** into a single packaged solution, with added features and flexibility:
|
||||
**InfluxDB 3** is InfluxDB’s next generation that unlocks series limitations present in the Time Structured Merge Tree (TSM) storage engine and allows infinite series cardinality without any impact on overall database performance. It also brings with it native SQL support and improved InfluxQL performance.
|
||||
|
||||
- [InfluxDB OSS 2.0](/influxdb/v2/get-started/): open source platform solution in a single binary
|
||||
### Self-hosted
|
||||
|
||||
- [InfluxDB 3 Core](/influxdb3/core/): open source time series database with object storage support and built-in data processing capabilities
|
||||
- [InfluxDB 3 Enterprise](/influxdb3/enterprise/): extends **Core** with clustering, high availability, and advanced security features
|
||||
- [InfluxDB Clustered 3](/influxdb3/clustered/): a highly available InfluxDB 3 cluster hosted and managed on your own infrastructure
|
||||
|
||||
### Hosted
|
||||
|
||||
- [InfluxDB Cloud Serverless](/influxdb3/cloud-serverless/): fully managed, multi-tenant InfluxDB 3 instance
|
||||
- [InfluxDB Cloud Dedicated](/influxdb3/cloud-dedicated/): fully managed, single-tenant InfluxDB 3 cluster
|
||||
|
||||
### InfluxDB 3 Explorer
|
||||
|
||||
[InfluxDB 3 Explorer](/influxdb3/explorer/) is the standalone web application designed for visualizing, querying, and managing your data stored in InfluxDB 3 Core and Enterprise.
|
||||
|
||||
### Telegraf
|
||||
|
||||
[Telegraf](/telegraf/v1/) is a plugin-driven server agent for collecting and reporting metrics. It supports over 300 input and output plugins, including support for InfluxDB 3.
|
||||
|
||||
## InfluxDB 2
|
||||
|
||||
> [!Note]
|
||||
> #### New InfluxDB Cloud signups use InfluxDB 3
|
||||
>
|
||||
> New InfluxDB Cloud signups are for [InfluxDB Cloud Serverless, powered by the InfluxDB 3 storage engine](/influxdb3/cloud-serverless/).
|
||||
>
|
||||
> If you are looking to use InfluxDB v2 (TSM), consider self-hosting [InfluxDB OSS v2](/influxdata/v2/).
|
||||
|
||||
The **InfluxDB 2 platform** consolidates InfluxDB, Chronograf, and Kapacitor from the **InfluxData 1.x platform** into a single packaged solution, with added features and flexibility:
|
||||
|
||||
- [InfluxDB OSS 2.x](/influxdb/v2/get-started/): open source platform solution in a single binary
|
||||
- [InfluxDB Cloud](/influxdb/cloud/get-started/) (**commercial offering**): hosted cloud solution
|
||||
- [Telegraf](#telegraf): collect data
|
||||
|
||||
{{% note %}}
|
||||
|
||||
#### Integrate InfluxDB 2.0 applications with InfluxDB Enterprise 1.8+
|
||||
|
||||
Use [InfluxDB 2.0 API compatibility endpoints](/enterprise_influxdb/v1/tools/api/#influxdb-20-api-compatibility-endpoints) to integrate applications built on InfluxDB 2.0 or InfluxDB Cloud with InfluxDB Enterprise 1.8+:
|
||||
|
||||
- Query data in InfluxDB Enterprise using `api/v2/query` and Flux.
|
||||
- Write data to InfluxDB Enterprise using `api/v2/write` (compatible with InfluxDB 2.0 client libraries).
|
||||
|
||||
|
||||
{{% /note %}}
|
||||
> [!Note]
|
||||
> #### Integrate InfluxDB 2.0 applications with InfluxDB Enterprise 1.8+
|
||||
>
|
||||
> Use [InfluxDB 2.0 API compatibility endpoints](/enterprise_influxdb/v1/tools/api/#influxdb-20-api-compatibility-endpoints) to integrate applications built on InfluxDB 2.0 or InfluxDB Cloud with InfluxDB Enterprise 1.8+:
|
||||
>
|
||||
> - Query data in InfluxDB Enterprise using `api/v2/query` and Flux.
|
||||
> - Write data to InfluxDB Enterprise using `api/v2/write` (compatible with InfluxDB 2.0 client libraries).
|
||||
|
||||
## InfluxData 1.x
|
||||
|
||||
|
|
@ -80,19 +116,18 @@ based on user-defined logic, and running ETL jobs.
|
|||
|
||||
InfluxDB Enterprise and Kapacitor Enterprise provide clustering, access control, and incremental backup functionality for production infrastructures at scale. You'll also receive direct support from the InfluxData support team.
|
||||
|
||||
{{% note %}}
|
||||
InfluxDB Enterprise and Kapacitor Enterprise are compatible with open source versions of Telegraf and Chronograf.
|
||||
{{% /note %}}
|
||||
> [!Note]
|
||||
> InfluxDB Enterprise and Kapacitor Enterprise are compatible with open source versions of Telegraf and Chronograf.
|
||||
|
||||
### InfluxDB Enterprise
|
||||
|
||||
InfluxDB Enterprise provides functionality necessary to run a high-availability (HA) InfluxDB cluster, providing clustering, horizontal scale out, and advanced access controls, including:
|
||||
|
||||
- Hinted handoff
|
||||
- Anti-entropy
|
||||
- Fine-grained authorization
|
||||
- Cluster profiling
|
||||
- Incremental backups
|
||||
- [Hinted handoff](#hinted-handoff)
|
||||
- [Anti-entropy](#anti-entropy)
|
||||
- [Fine-grained authorization](#fine-grained-authorization)
|
||||
- [Cluster profiling](#cluster-profiling)
|
||||
- [Incremental backups](#incremental-backups)
|
||||
|
||||
#### Hinted handoff
|
||||
|
||||
|
|
@ -109,7 +144,7 @@ data) is detected, AE will repair the affected shards, syncing the missing data.
|
|||
|
||||
#### Fine-grained authorization
|
||||
|
||||
In InfluxDB Enterprise, fine-grained authorization can be used to control access
|
||||
In InfluxDB Enterprise, [fine-grained authorization](/enterprise_influxdb/v1/administration/manage/users-and-permissions/introduction-to-auth/) can be used to control access
|
||||
at the measurement or series levels rather than just the database level.
|
||||
|
||||
#### Cluster profiling
|
||||
|
|
@ -117,11 +152,16 @@ at the measurement or series levels rather than just the database level.
|
|||
Enterprise meta nodes expose the `/debug/pprof` API endpoint that allows you to
|
||||
profile and potentially diagnose performance bottlenecks in your cluster.
|
||||
|
||||
For more information about monitoring and profiling your cluster, see
|
||||
[Monitor InfluxDB Enterprise](/enterprise_influxdb/v1/administration/monitor).
|
||||
|
||||
#### Incremental backups
|
||||
|
||||
InfluxDB Enterprise allows for incremental backups that write only newly added
|
||||
data to existing backup files rather than backing up all data in a new backup.
|
||||
|
||||
For more information, see [InfluxDB Enterprise clustering features](/enterprise_influxdb/v1/features/clustering-features/)
|
||||
|
||||
### Kapacitor Enterprise
|
||||
|
||||
Kapacitor Enterprise provides functionality necessary to run a high-availability
|
||||
|
|
@ -148,12 +188,3 @@ Kapacitor Enterprise includes configuration options that let you encrypt
|
|||
communication between your Kapacitor Enterprise and InfluxDB Enterprise clusters.
|
||||
|
||||
<a class="btn" href="https://portal.influxdata.com/" target="\_blank">Try InfluxData Platform Enterprise</a>
|
||||
|
||||
## Get started
|
||||
|
||||
To get started with the **InfluxData 1.x** platform, see
|
||||
|
||||
[Installation and Configuration](/platform/install-and-deploy/)
|
||||
[Getting Started](/platform/introduction/getting-started)
|
||||
|
||||
To get started with the **InfluxDB 2.0** platform, see [**InfluxDB Cloud**](/influxdb/cloud/get-started/) or [**InfluxDB OSS 2.0**](/influxdb/v2/get-started/).
|
||||
|
|
|
|||
|
|
@ -9,7 +9,15 @@ menu:
|
|||
weight: 2
|
||||
---
|
||||
|
||||
To get started with the **InfluxDB 2.0** platform, see [**InfluxDB Cloud**](/influxdb/cloud/get-started/) or [**InfluxDB OSS 2.0**](/influxdb/v2/get-started/).
|
||||
To get started with **InfluxDB 3**:
|
||||
|
||||
1. Install [InfluxDB 3 Core](/influxdb3/core/get-started/) or [InfluxDB 3 Enterprise](/influxdb3/enterprise/get-started/) (a trial license is available).
|
||||
|
||||
2. Install [InfluxDB 3 Explorer](/influxdb3/explorer/get-started/) to visualize and explore your data.
|
||||
|
||||
3. Install [Telegraf](/telegraf/v1/get_started/) to collect and send data to your InfluxDB 3 instance.
|
||||
|
||||
## Other versions of InfluxDB
|
||||
|
||||
To get started with the **InfluxData 1.x** platform, [download and install](/platform/install-and-deploy/install/) each component of the TICK stack, or [Install the InfluxData Sandbox](/platform/install-and-deploy/deploying/sandbox-install/), and then follow the steps below.
|
||||
|
||||
|
|
@ -52,3 +60,5 @@ Now that you've explored your data with queries, you can build a dashboard in Ch
|
|||
Since InfluxDB is running on `localhost:8086`, Kapacitor finds it during start up and creates several subscriptions on InfluxDB. These subscriptions tell InfluxDB to send all the data it receives from Telegraf to Kapacitor.
|
||||
|
||||
For step-by-step instructions on how to set up an alert in Kapacitor based on your data, see [Creating Chronograf alert rules](/chronograf/v1/guides/create-alert-rules/).
|
||||
|
||||
To get started with the **InfluxDB 2.x** platform, see [**InfluxDB OSS 2.x**](/influxdb/v2/get-started/).
|
||||
|
|
|
|||
|
|
@ -1,15 +0,0 @@
|
|||
---
|
||||
title: Install and deploy the InfluxData Platform
|
||||
description: Quickly install and configure the InfluxData Platform to work with time series data
|
||||
menu:
|
||||
platform:
|
||||
name: Install and deploy
|
||||
identifier: install-and-deploy-platform
|
||||
weight: 20
|
||||
---
|
||||
|
||||
To install and configure the **InfluxDB 2.0** platform, see [**InfluxDB Cloud**](/influxdb/cloud/get-started/) or [**InfluxDB OSS 2.0**](/influxdb/v2/get-started/).
|
||||
|
||||
To install and configure InfluxDB 1.x platform manually or deploy leveraging containers and other technologies, follow the links below.
|
||||
|
||||
{{< children >}}
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
---
|
||||
title: Deploy the 1.x TICK stack
|
||||
description: Easy ways to deploy the TICK stack on the platform you use.
|
||||
menu:
|
||||
platform:
|
||||
name: Deploy InfluxData Platform
|
||||
identifier: deploy-platform
|
||||
weight: 22
|
||||
parent: install-and-deploy-platform
|
||||
---
|
||||
|
||||
To deploy InfluxDB 2.0 on your Cloud provider, see how to [Subscribe through a cloud provider](/influxdb/cloud/get-started/#subscribe-through-a-cloud-provider).
|
||||
|
||||
There are multiple ways to deploy the InfluxDB 1.x platform (also known
|
||||
as the TICK stack). See if one of the following container-based
|
||||
installation options meets your requirements.
|
||||
|
||||
{{< children >}}
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
title: Deploy an InfluxDB Enterprise cluster on Amazon Web Services
|
||||
list_title: Deploy on AWS
|
||||
description: Use the Terraform InfluxDB AWS Module to deploy single or multi- cluster architectures on Amazon Web Services.
|
||||
menu:
|
||||
platform:
|
||||
name: AWS
|
||||
parent: deploy-platform
|
||||
weight: 3
|
||||
---
|
||||
|
||||
InfluxData recommends using the Terraform [InfluxDB AWS Module](https://github.com/gruntwork-io/terraform-aws-influx) to deploy a single InfluxDB Enterprise cluster or a multi-cluster architecture on Amazon Web Services.
|
||||
|
||||
### InfluxDB AWS Module (Terraform)
|
||||
|
||||
The [InfluxDB AWS Module] is the official module for deploying InfluxDB Enterprise on AWS using [Terraform](https://www.terraform.io/) and [Packer](https://www.packer.io/).
|
||||
|
||||
The InfluxDB AWS Module, maintained by [Gruntwork](http://www.gruntwork.io/), was written using a combination of Terraform and scripts (mostly bash) and includes automated tests, documentation, and examples.
|
||||
|
||||
For details on using this Terraform module to deploy InfluxDB Enterprise clusters, see the [InfluxDB AWS Module repository](https://github.com/gruntwork-io/terraform-aws-influx).
|
||||
|
|
@ -1,89 +0,0 @@
|
|||
---
|
||||
title: Deploy the InfluxData Platform in Google Cloud Platform
|
||||
list_title: Deploy on Google Cloud Platform
|
||||
description: Deploy the InfluxData Platform and InfluxDB Enterprise clusters in Google Cloud Platform
|
||||
menu:
|
||||
platform:
|
||||
name: Google Cloud Platform
|
||||
parent: deploy-platform
|
||||
weight: 2
|
||||
---
|
||||
|
||||
For deploying InfluxDB Enterprise clusters on Google Cloud Platform (GCP) infrastructure, InfluxData provides an [InfluxDB Enterprise bring-your-own-license (BYOL) solution](https://console.cloud.google.com/marketplace/details/influxdata-public/influxdb-enterprise-byol) on the [Google Cloud Platform Marketplace](https://cloud.google.com/marketplace/) that makes the installation and setup process easy and straightforward. Clusters deployed through the GCP Marketplace are ready for production.
|
||||
|
||||
{{% note %}}
|
||||
The [Deployment Manager templates](https://cloud.google.com/deployment-manager/) used for the InfluxDB Enterprise BYOL solution are [open source](https://github.com/influxdata/google-deployment-manager-influxdb-enterprise). Issues and feature requests for the Marketplace deployment should be [submitted through the related GitHub repository](https://github.com/influxdata/google-deployment-manager-influxdb-enterprise/issues/new) (requires a GitHub account) or by contacting [InfluxData support](mailto:Support@InfluxData.com).
|
||||
{{% /note %}}
|
||||
|
||||
## Prerequisites
|
||||
|
||||
This guide requires the following:
|
||||
|
||||
- A [Google Cloud Platform (GCP)](https://cloud.google.com/) account with access to the [GCP Marketplace](https://cloud.google.com/marketplace/).
|
||||
- A valid InfluxDB Enterprise license key, or [sign up for a free InfluxDB Enterprise trial for GCP](https://portal.influxdata.com/users/gcp).
|
||||
- Access to [GCP Cloud Shell](https://cloud.google.com/shell/) or the [`gcloud` SDK and command line tools](https://cloud.google.com/sdk/).
|
||||
|
||||
To deploy InfluxDB Enterprise on platforms other than GCP, please see [InfluxDB Enterprise installation options](/enterprise_influxdb/v1/introduction/installation_guidelines).
|
||||
|
||||
## Deploy a cluster
|
||||
|
||||
To deploy an InfluxDB Enterprise cluster, log in to your Google Cloud Platform account and navigate to [InfluxData's InfluxDB Enterprise (BYOL)](https://console.cloud.google.com/partner/editor/influxdata-public/influxdb-enterprise-byol) solution in the GCP Marketplace.
|
||||
|
||||
|
||||
|
||||
Click __Launch on compute engine__ to open up the configuration page.
|
||||
|
||||
|
||||
|
||||
Copy the InfluxDB Enterprise license key to the __InfluxDB Enterprise license key__ field or [sign up for a free InfluxDB Enterprise trial for GCP](https://portal.influxdata.com/users/gcp) to obtain a license key.
|
||||
|
||||
Adjust any other fields as desired. The cluster will only be accessible within the network (or subnetwork, if specified) in which it is deployed. The fields in collapsed sections generally do not need to be altered.
|
||||
|
||||
Click __Deploy__ to launch the InfluxDB Enterprise cluster.
|
||||
|
||||
|
||||
|
||||
The cluster will take up to five minutes to fully deploy. If the deployment does not complete or reports an error, read through the list of [common deployment errors](https://cloud.google.com/marketplace/docs/troubleshooting).
|
||||
|
||||
|
||||
|
||||
Your cluster is now deployed!
|
||||
|
||||
{{% note %}}
|
||||
Make sure you save the "Admin username", "Admin password", and "Connection internal IP" values displayed on the screen. They will be required when attempting to access the cluster.
|
||||
{{% /note %}}
|
||||
|
||||
## Access the cluster
|
||||
|
||||
The cluster's IP address is only reachable from within the GCP network (or subnetwork) specified in the solution configuration. A cluster can only be reached from instances or services within the same GCP network or subnetwork in which it was provisioned.
|
||||
|
||||
Using the GCP Cloud Shell or `gcloud` CLI, create a new instance that will be used to access the InfluxDB Enterprise cluster.
|
||||
|
||||
```
|
||||
gcloud compute instances create influxdb-access --zone us-central1-f --image-family debian-9 --image-project debian-cloud
|
||||
```
|
||||
|
||||
SSH into the instance.
|
||||
|
||||
```
|
||||
gcloud compute ssh influxdb-access
|
||||
```
|
||||
|
||||
On the instance, install the `influx` command line tool via the InfluxDB open source package.
|
||||
|
||||
```
|
||||
wget https://dl.influxdata.com/influxdb/releases/influxdb_1.6.3_amd64.deb
|
||||
sudo dpkg -i influxdb_1.6.3_amd64.deb
|
||||
```
|
||||
|
||||
Now the InfluxDB Enterprise cluster can be accessed using the following command with "Admin username", "Admin password", and "Connection internal IP" values from the deployment screen substituted for `<value>`.
|
||||
|
||||
```
|
||||
influx -username <Admin username> -password <Admin password> -host <Connection internal IP> -execute "CREATE DATABASE test"
|
||||
|
||||
influx -username <Admin username> -password <Admin password> -host <Connection internal IP> -execute "SHOW DATABASES"
|
||||
```
|
||||
|
||||
### Next steps
|
||||
|
||||
For an introduction to InfluxDB database and the InfluxData Platform, see [Getting started with InfluxDB](/platform/introduction/getting-started).
|
||||
|
|
@ -1,35 +0,0 @@
|
|||
---
|
||||
title: Deploy InfluxData Platform components in Kubernetes
|
||||
list_title: Deploy with Kubernetes
|
||||
description: Deploy the InfluxData Platform components in Kubernetes
|
||||
menu:
|
||||
platform:
|
||||
name: Kubernetes
|
||||
identifier: deploy-k8s
|
||||
parent: deploy-platform
|
||||
weight: 4
|
||||
---
|
||||
|
||||
Install and configure the TICK stack—Telegraf, InfluxDB, Chronograf, and Kapacitor—in Kubernetes.
|
||||
|
||||
### Use Helm Charts to deploy InfluxData Platform components
|
||||
|
||||
InfluxData provides [InfluxData Helm charts](https://github.com/influxdata/helm-charts) to install the platform on Kubernetes.
|
||||
|
||||
To install the InfluxDB 2.0 platform, use the following Helm charts:
|
||||
|
||||
- [InfluxDB 2.0](https://github.com/influxdata/helm-charts/tree/master/charts/influxdb2)
|
||||
- [Telegraf](https://github.com/influxdata/helm-charts/tree/master/charts/telegraf)
|
||||
|
||||
To install the InfluxDB 1.x platform, use the following Helm charts:
|
||||
|
||||
- [Telegraf](https://github.com/influxdata/helm-charts/tree/master/charts/telegraf)
|
||||
- [InfluxDB 1.x](https://github.com/influxdata/helm-charts/tree/master/charts/influxdb)
|
||||
- [Chronograf](https://github.com/influxdata/helm-charts/tree/master/charts/chronograf)
|
||||
- [Kapacitor](https://github.com/influxdata/helm-charts/tree/master/charts/kapacitor)
|
||||
|
||||
### Use the InfluxDB Operator
|
||||
|
||||
[InfluxDB operator](https://github.com/influxdata/influxdata-operator) is a [Kubernetes operator](https://coreos.com/operators/) that can be used to deploy InfluxDB 1.x OSS in Kubernetes. The InfluxDB operator can handle operational tasks, like creating a backup, automatically. The operator currently has been tested on [AWS's Elastic Kubernetes Service](https://aws.amazon.com/eks/) and [GCP's Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/).
|
||||
|
||||
[Deploy InfluxDB using the InfluxData operator](https://github.com/influxdata/influxdata-operator)
|
||||
|
|
@ -1,116 +0,0 @@
|
|||
---
|
||||
title: Deploy the InfluxData Platform (TICK stack) in Docker containers
|
||||
list_title: Deploy the TICK Sandbox in Docker
|
||||
description: Install the InfluxData Sandbox, the quickest way to get a TICK stack up and running and ready for exploration and testing.
|
||||
aliases:
|
||||
- /platform/installation/sandbox-install
|
||||
menu:
|
||||
platform:
|
||||
name: Docker sandbox
|
||||
parent: deploy-platform
|
||||
weight: 1
|
||||
---
|
||||
|
||||
The quickest way to start using the InfluxDB 1.x platform (TICK stack) OSS is to download and deploy the [InfluxData Sandbox](https://github.com/influxdata/sandbox). The InfluxData Sandbox uses Docker containers to deploy the InfluxData Platform components. The InfluxData Sandbox provides a containerized, ready-to-use TICK stack, built using [Docker](https://www.docker.com) and [Docker Compose](https://docs.docker.com/compose/overview/), to capture data from your local machine and the Docker containers.
|
||||
|
||||
After deploying using the InfluxData Sandbox, you will have the latest versions of:
|
||||
|
||||
* Telegraf
|
||||
* InfluxDB OSS
|
||||
* Chronograf
|
||||
* Kapacitor OSS
|
||||
|
||||
{{% note %}}
|
||||
The InfluxData Sandbox is not recommended for production use.
|
||||
{{% /note %}}
|
||||
|
||||
## Requirements
|
||||
|
||||
- Linux or macOS <em style="opacity:.5;margin-left:.5em;">(Windows support is experimental)</em>
|
||||
- [Git](https://git-scm.com/)
|
||||
- [Docker](https://docs.docker.com/install/#supported-platforms)
|
||||
- [Docker Compose](https://docs.docker.com/compose/install/)
|
||||
<em style="opacity:.5;margin-left:.5em;">(Packaged with Docker for Mac)</em>
|
||||
|
||||
## Download and run the Sandbox
|
||||
|
||||
The InfluxData Sandbox is open source and is available for
|
||||
[download from Github](https://github.com/influxdata/sandbox).
|
||||
To download it, use `git` to clone the source repository:
|
||||
|
||||
```bash
|
||||
# Clone the InfluxData Sandbox from Github
|
||||
git clone https://github.com/influxdata/sandbox.git
|
||||
```
|
||||
|
||||
The Sandbox repo includes a `sandbox` binary used to provision and manage the
|
||||
Sandbox's containers and data. Run `./sandbox up` from inside the `sandbox` directory
|
||||
to download the necessary images, then build and start all the required Docker containers.
|
||||
|
||||
```bash
|
||||
# cd into the sandbox directory
|
||||
cd sandbox
|
||||
|
||||
# Start the sandbox
|
||||
./sandbox up
|
||||
```
|
||||
|
||||
{{% note %}}
|
||||
Make sure no other instances of TICK stack components are running on your local
|
||||
machine when starting the Sandbox. Otherwise you will run into port conflicts
|
||||
and the Sandbox won't be able to start properly.
|
||||
{{% /note %}}
|
||||
|
||||
Once started, two tabs will open in your browser:
|
||||
|
||||
1. Chronograf ([localhost:8888](http://localhost:8888))
|
||||
2. InfluxData Sandbox Documentation ([localhost:3010](http://localhost:3010))
|
||||
|
||||
Chronograf is the web-based user interface for the TICK stack and can be used to manage the stack. You can use Chronograf to:
|
||||
|
||||
* query and explore data
|
||||
* [create Kapacitor alerts](/chronograf/v1/guides/create-alert-rules/)
|
||||
* preview [data visualizations](/chronograf/v1/guides/visualization-types/)
|
||||
* [build custom dashboards](/chronograf/v1/guides/create-a-dashboard/)
|
||||
|
||||
### Using nightly builds
|
||||
|
||||
The `./sandbox up` command includes a `-nightly` option that will pull nightly
|
||||
builds for InfluxDB and Chronograf, giving you the most recent updates and
|
||||
experimental functionality.
|
||||
|
||||
{{% warn %}}
|
||||
Nightly builds are experimental and are not guaranteed to be functional.
|
||||
{{% /warn %}}
|
||||
|
||||
```bash
|
||||
./sandbox up -nightly
|
||||
```
|
||||
|
||||
## Interacting with the Sandbox TICK stack
|
||||
|
||||
With the Sandbox running, each component of the TICK stack is available to work with.
|
||||
The Sandbox documentation provides tutorials for interacting with each component.
|
||||
The documentation is available at [localhost:3010/tutorials](http://localhost:3010/tutorials)
|
||||
(with the Sandbox running) or [on Github](https://github.com/influxdata/sandbox/tree/master/documentation/static/tutorials).
|
||||
|
||||
All configuration files, tools, and CLIs needed for managing each component of the
|
||||
TICK stack are included in their respective Docker containers.
|
||||
Tasks outlined throughout the InfluxData documentation can be accomplished using
|
||||
the InfluxData Sandbox.
|
||||
|
||||
The `./sandbox enter` command opens a console inside the specified container where
|
||||
the project's configuration files and CLIs are available.
|
||||
|
||||
```bash
|
||||
# Pattern
|
||||
./sandbox enter [ telegraf | influxdb | chronograf | kapacitor ]
|
||||
|
||||
# Example: console into the telegraf container
|
||||
./sandbox enter telegraf
|
||||
```
|
||||
|
||||
{{% note %}}
|
||||
After updating a configuration file in a Sandbox container, use the `./sandbox restart`
|
||||
command to restart the containers and apply the updated configuration.
|
||||
{{% /note %}}
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
---
|
||||
title: Install the InfluxData platform
|
||||
description: Quickly install and configure the InfluxData platform to begin exploring time series data
|
||||
menu:
|
||||
platform:
|
||||
name: Install the InfluxData Platform
|
||||
weight: 11
|
||||
identifier: install-platform
|
||||
parent: install-and-deploy-platform
|
||||
---
|
||||
|
||||
To install and configure the **InfluxDB 2.0** platform, see [**InfluxDB Cloud**](/influxdb/cloud/get-started/) or [**InfluxDB OSS 2.0**](/influxdb/v2/get-started/).
|
||||
|
||||
To get install and configure the **InfluxData 1.x** platform, use one of the following methods:
|
||||
|
||||
- For **non-production** environments. The quickest way to install the InfluxData platform is to [deploy the InfluxData 1.x platform in Docker containers](/platform/install-and-deploy/deploying/sandbox-install).
|
||||
- For **production** environments. Do one of the following:
|
||||
|
||||
- [Install the open source version of InfluxData 1.x platform](/platform/install-and-deploy/install/oss-install)
|
||||
- Install InfluxData 1.x Enterprise:
|
||||
1. [Install Telegraf](/telegraf/v1/install/)
|
||||
2. [Install InfluxDB Enterprise](/enterprise_influxdb/v1/install-and-deploy/)
|
||||
|
||||
{{% note %}}
|
||||
Windows support is experimental.
|
||||
{{% /note %}}
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
---
|
||||
title: Install the InfluxData 1.x TICK stack (OSS)
|
||||
list_title: TICK stack (OSS)
|
||||
description: Install and configure the open source InfluxData 1.x TICK stack – Telegraf, InfluxDB, Chronograf, and Kapacitor.
|
||||
aliases:
|
||||
- /platform/installation/oss-install
|
||||
menu:
|
||||
platform:
|
||||
name: TICK stack (OSS)
|
||||
parent: install-platform
|
||||
weight: 2
|
||||
---
|
||||
|
||||
## Download the TICK stack components
|
||||
|
||||
To download each of the TICK stack components, see [InfluxData downloads page](https://www.influxdata.com/downloads/).
|
||||
Telegraf, InfluxDB, Chronograf, and Kapacitor are each separate binaries that need
|
||||
to be installed, configured, and started separately.
|
||||
|
||||
|
||||
## Install Telegraf
|
||||
|
||||
The [Telegraf installation instructions](/telegraf/v1/install/)
|
||||
walk through installing and configuring Telegraf.
|
||||
|
||||
## Install InfluxDB
|
||||
|
||||
The [InfluxDB OSS installation instructions](/influxdb/v1/introduction/installation/)
|
||||
walk through installing and configuring the open source version of InfluxDB.
|
||||
|
||||
## Install Chronograf
|
||||
|
||||
The [Chronograf installation instructions](/chronograf/v1/introduction/installation/)
|
||||
walk through installing and configuring Chronograf.
|
||||
|
||||
## Install Kapacitor
|
||||
|
||||
The [Kapacitor OSS installation instructions](/kapacitor/v1/introduction/installation/)
|
||||
walk through installing and configuring the open source version of Kapacitor.
|
||||
|
||||
## InfluxData Sandbox
|
||||
|
||||
The [InfluxData Sandbox](https://github.com/influxdata/sandbox) is an alternative
|
||||
method for installing the OSS TICK stack that uses Docker and Docker Compose to build
|
||||
and network each component. For information about installing the Sandbox, view the
|
||||
[InfluxData Sandbox installation instructions](/platform/install-and-deploy/deploying/sandbox-install).
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
---
|
||||
title: Integrate the InfluxData 1.x TICK stack
|
||||
description: Discover all ways the TICK stack integrates into your favorite projects.
|
||||
menu:
|
||||
platform:
|
||||
name: Integrate
|
||||
identifier: integrate-platform
|
||||
weight: 40
|
||||
---
|
||||
|
||||
The InfluxDB 1.x platform integrates with a number of platforms and technologies. These pages document the integrations and provide
|
||||
links to additional material.
|
||||
|
||||
{{< children >}}
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
---
|
||||
title: Docker
|
||||
description: InfluxData projects are well suited to be deployed in Docker containers. Containers for each project are published to DockerHub.
|
||||
menu:
|
||||
platform:
|
||||
name: Docker
|
||||
parent: integrate-platform
|
||||
---
|
||||
|
||||
InfluxData projects are well suited to be deployed in Docker containers. Containers for each project are published to DockerHub.
|
||||
|
||||
- [Telegraf](https://hub.docker.com/_/telegraf/)
|
||||
- [InfluxDB](https://hub.docker.com/_/influxdb/)
|
||||
- [Chronograf](https://hub.docker.com/_/chronograf/)
|
||||
- [Kapacitor](https://hub.docker.com/_/kapacitor/)
|
||||
|
||||
The source for all containers is available [here](https://github.com/influxdata/influxdata-docker).
|
||||
|
|
@ -1,99 +0,0 @@
|
|||
---
|
||||
title: Kubernetes
|
||||
description: Deploy InfluxDB OSS in Kubernetes and monitor Kubernetes
|
||||
menu:
|
||||
platform:
|
||||
name: Kubernetes
|
||||
parent: integrate-platform
|
||||
---
|
||||
|
||||
[Kubernetes](https://kubernetes.io/) is a popular way to deploy and manage containers across multiple servers and cloud providers.
|
||||
|
||||
{{% note %}}
|
||||
This page is about using Kubernetes with the TICK stack and 1.x versions of InfluxDB.
|
||||
To install InfluxDB 2.x and Kubernetes, see the **Kubernetes** tab in [Install InfluxDB v2](/influxdb/v2/install/?t=Kubernetes).
|
||||
{{% /note %}}
|
||||
|
||||
Use InfluxData platform and Kubernetes to do the following:
|
||||
|
||||
- [Monitor Kubernetes](#monitor-kubernetes)
|
||||
- [Use the kube-influxdb project](#use-the-kube--influxdb-project)
|
||||
- [Collect Kubernetes metrics with Telegraf](#collect-kubernetes-metrics-with-telegraf)
|
||||
- [Use the Prometheus remote read and write API](#use-the-prometheus-remote-read-and-write-api)
|
||||
- [Deploy the TICK stack in Kubernetes](#deploy-the-tick-stack-in-kubernetes)
|
||||
- [Helm Charts](#helm-charts)
|
||||
- [K8s Operator](#k8s-operator)
|
||||
- [Solutions for Kubernetes services](#solutions-for-kubernetes-services)
|
||||
- [Frequently asked questions](#frequently-asked-questions)
|
||||
- [How is the InfluxData Platform (TICK) different from Prometheus?](#how-is-the-influxdata-platform-tick-different-from-prometheus)
|
||||
- [Should I run InfluxDB in Kubernetes?](#should-i-run-influxdb-in-kubernetes)
|
||||
|
||||
## Monitor Kubernetes
|
||||
|
||||
Use the TICK stack to monitor services that make up a Kubernetes cluster, whether you're running InfluxDB in a Kubernetes cluster or somewhere else. Do the following to monitor Kubernetes:
|
||||
|
||||
- Use the [kube-influxdb project](#kube--influxdb-project)
|
||||
- [Collect Kubernetes metrics with Telegraf](#collect-kubernetes-metrics-with-telegraf)
|
||||
- [### Use the Prometheus remote read and write API](#use-the-prometheus-remote-read-and-write-api)
|
||||
|
||||
### Use the kube-influxdb project
|
||||
|
||||
The [kube-influxdb](https://github.com/influxdata/kube-influxdb) project is a
|
||||
set of Helm charts to make collection and visualization of Kubernetes metrics
|
||||
easy. It uses Telegraf, the metrics collection agent, to collect metrics and
|
||||
events and includes a set of pre-configured Chronograf dashboards.
|
||||
|
||||
See the [kube-influxdb Getting Started guide](https://github.com/influxdata/kube-influxdb/blob/master/docs/v1.0/getting_started.md).
|
||||
|
||||
### Collect Kubernetes metrics with Telegraf
|
||||
|
||||
Use [Telegraf](/telegraf/v1/get-started/) to collect metrics in a Kubernetes cluster, including
|
||||
[Docker container metrics](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/docker/README.md)
|
||||
and [stats from kubelets](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/kubernetes).
|
||||
Or use Telegraf to scrape [Prometheus metrics API endpoints](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/prometheus).
|
||||
Telegraf is used in the [kube-influxdb project](#kube-influxdb-kubernetes-monitoring-project)
|
||||
to collect metrics.
|
||||
|
||||
See [Set up a Kubernetes monitoring architecture using Telegraf](https://www.influxdata.com/blog/monitoring-kubernetes-architecture/).
|
||||
|
||||
### Use the Prometheus remote read and write API
|
||||
|
||||
Use the Prometheus remote read and write API for clusters already using Prometheus for metrics collection.
|
||||
For more information, see [Prometheus remote read and write API support in InfluxDB](/influxdb/v1/supported_protocols/prometheus/).
|
||||
|
||||
## Deploy the TICK stack in Kubernetes
|
||||
|
||||
To install and configure the open source TICK stack--Telegraf, InfluxDB, Chronograf, and Kapacitor--in Kubernetes, do one of the following:
|
||||
|
||||
- [Use Helm charts](#use-helm-charts)
|
||||
- [Use K8s operator](#use-k8s-operator)
|
||||
- [Use solutions for Kubernetes services](#use-solutions-for-kubernetes-services)
|
||||
|
||||
### Use Helm charts
|
||||
|
||||
InfluxData maintains [Helm charts](https://github.com/influxdata/helm-charts) for setting up data collection and monitoring in Kubernetes using InfluxDB and related applications.
|
||||
|
||||
### Use K8s operator
|
||||
|
||||
The [InfluxData operator](https://github.com/influxdata/influxdata-operator) is
|
||||
a [Kubernetes operator](https://coreos.com/operators/). Use the InfluxData operator to deploy InfluxDB in Kubernetes and handle operational tasks automatically, like creating a backup. The operator has been tested on [AWS's Elastic Kubernetes Service](https://aws.amazon.com/eks/) and [GCP's Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/).
|
||||
|
||||
[Deploy InfluxDB using the InfluxData
|
||||
operator](https://github.com/influxdata/influxdata-operator)
|
||||
|
||||
### Use solutions for Kubernetes services
|
||||
|
||||
InfluxData maintains ways to deploy the InfluxData Platform components to popular Kubernetes service providers.
|
||||
|
||||
- [TICK Stack on the AWS Container Marketplace](https://aws.amazon.com/marketplace/pp/B07KGM885K?qid=1544514373950&sr=0-18&ref_=srh_res_product_title)
|
||||
- [Telegraf, InfluxDB, and Grafana on the GCP Marketplace](https://console.cloud.google.com/marketplace/details/influxdata-public/telegraf-influxdb-grafana?q=telegraf)
|
||||
|
||||
## Frequently asked questions
|
||||
|
||||
### How is the InfluxData platform (TICK) different from Prometheus?
|
||||
|
||||
InfluxDB is specifically built to handle time series data. InfluxDB handles string data types and event data that occurs in irregular intervals, including structured logs, application events, and tracing data.
|
||||
|
||||
### How should I run InfluxDB in Kubernetes?
|
||||
|
||||
InfluxData provides several [ways to deploy InfluxDB in Kubernetes](/platform/install-and-deploy/deploying/kubernetes/). For a declarative way to deploy InfluxDB, we recommend exploring the [Terraform InfluxDB module](https://registry.terraform.io/modules/influxdata/influxdb/aws/1.0.4).
|
||||
|
|
@ -8,7 +8,6 @@ menu:
|
|||
parent: Monitor
|
||||
---
|
||||
|
||||
This is a new section of the documentation and new content will be added frequently
|
||||
as support for the InfluxData Platform and containers rapidly evolves.
|
||||
Use the InfluxData 1.x TICK stack to monitor containers, including Kubernetes and Docker
|
||||
|
||||
{{< children >}}
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Monitor the InfluxData Platform
|
||||
description: How to use the InfluxData to monitor itself and other instances to identify and alert on anomalies.
|
||||
description: Use InfluxDB to monitor your stack's health and identify issues before they impact operations.
|
||||
menu:
|
||||
platform:
|
||||
name: Monitor the InfluxData Platform
|
||||
|
|
@ -9,27 +9,33 @@ menu:
|
|||
parent: Monitor
|
||||
---
|
||||
|
||||
One of the primary use cases for the InfluxData Platform is as server and infrastructure
|
||||
monitoring solution. No matter what type of data you're using the platform to collect and
|
||||
store, it's important to monitor the health of your stack and identify any potential issues.
|
||||
Monitoring your stack's health is essential for identifying and addressing issues before they impact operations.
|
||||
The InfluxData Platform is built to collect, process, transform, and store event and time series data, making it well-suited for server and infrastructure monitoring.
|
||||
|
||||
To **monitor the InfluxDB 2.0 platform**, see [Monitor InfluxDB 2.0](/influxdb/v2/monitor-alert/).
|
||||
## Monitor with InfluxDB 3
|
||||
|
||||
To **monitor the InfluxData 1.x platform**, see the following pages for information about setting up a 1.x TICK stack that monitors
|
||||
another OSS or Enterprise TICK stack. They cover different potential monitoring strategies
|
||||
and visualizing the monitoring data in a way that makes it easy to recognize, alert on,
|
||||
and address anomalies as they happen.
|
||||
InfluxDB 3 delivers high-performance time series data management at scale with SQL and
|
||||
InfluxQL querying and built-in data processing capabilities.
|
||||
|
||||
Leverage [InfluxDB Cloud](/influxdb/cloud/) and pre-built [InfluxDB templates](/influxdb/cloud/tools/influxdb-templates/)
|
||||
to monitoring your InfluxDB setup.
|
||||
Start using InfluxDB Cloud at no cost with the Free Plan.
|
||||
Use it as much and as long as you like within the plan’s rate-limits.
|
||||
Limits are designed to let you monitor 5-10 sensors, stacks or servers comfortably.
|
||||
Monitoring a single InfluxDB OSS instance or even a modest InfluxDB Enterprise
|
||||
cluster should easily fit within the free plan limits.
|
||||
If you exceed the plan [limits](/influxdb/cloud/account-management/limits/) because of high resolution data or longer data retention,
|
||||
upgrade to the [Usage-Based Plan](/influxdb/cloud/account-management/pricing-plans/#usage-based-plan).
|
||||
- Collect and label metrics with [Telegraf](/telegraf/v1/) and send them to your InfluxDB 3 instance
|
||||
- Store and query metrics using [InfluxDB 3 Core](/influxdb3/core/) or [InfluxDB 3 Enterprise](/influxdb3/enterprise/)
|
||||
- Process and analyze data directly in the database with the built-in Python processing engine—use and extend pre-built plugins to run analysis, generate alerts, and send notifications in real-time, on-demand, or on a schedule:
|
||||
- [Use and extend plugins for InfluxDB 3 Core](/influxdb3/core/process-data/python/plugins/)
|
||||
- [Use and extend plugins for InfluxDB 3 Enterprise](/influxdb3/enterprise/process-data/python/plugins/)
|
||||
- Visualize metrics and explore your data with [InfluxDB 3 Explorer](/influxdb3/explorer/)
|
||||
|
||||
Start monitoring your InfluxDB instance by signing up for an [InfluxDB Cloud account](https://cloud2.influxdata.com/signup).
|
||||
## Monitor with other InfluxDB versions
|
||||
|
||||
### InfluxDB 2.x
|
||||
|
||||
See [Monitor InfluxDB 2.0](/influxdb/v2/monitor-alert/) for monitoring strategies specific to InfluxDB 2.x.
|
||||
|
||||
### InfluxDB Enterprise v1
|
||||
|
||||
See [Monitor InfluxDB Enterprise](/enterprise_influxdb/v1/administration/monitor/) for Enterprise v1 monitoring documentation.
|
||||
|
||||
### InfluxDB v1.x (TICK stack)
|
||||
|
||||
The following pages provide monitoring strategies, visualizations, and alerting approaches using the TICK stack:
|
||||
|
||||
{{< children >}}
|
||||
|
|
|
|||
|
|
@ -19,7 +19,8 @@ These are the two main approaches to Monitoring your TICK stack:
|
|||
|
||||
## Internal monitoring
|
||||
|
||||
{{% warn %}}Not recommended for production environments.{{% /warn %}}
|
||||
> [!Warning]
|
||||
> Not recommended for production environments.
|
||||
|
||||
By default, the InfluxData platform is configured to monitor itself.
|
||||
Telegraf collects metrics from the host on which it's running for things such as
|
||||
|
|
|
|||
|
|
@ -1,11 +0,0 @@
|
|||
---
|
||||
title: Operations guide
|
||||
description: placeholder
|
||||
menu:
|
||||
platform:
|
||||
name: Operations guide
|
||||
weight: 100
|
||||
draft: true
|
||||
---
|
||||
|
||||
This is the ops guide
|
||||
|
|
@ -1,6 +1,12 @@
|
|||
---
|
||||
title: Troubleshoot issues using InfluxData 1.x Platform monitoring
|
||||
description: placeholder
|
||||
aliases:
|
||||
- /platform/troubleshoot/hhq-buildup/
|
||||
- /platform/troubleshoot/iops/
|
||||
- /platform/troubleshoot/log-analysis/
|
||||
- /platform/troubleshoot/read-write-volume/
|
||||
- /platform/troubleshoot/runaway-series-cardinality/
|
||||
menu:
|
||||
platform:
|
||||
name: Troubleshoot
|
||||
|
|
|
|||
|
|
@ -1,12 +0,0 @@
|
|||
---
|
||||
title: Troubleshooting Hinted Handoff Queue buildup
|
||||
description: placeholder
|
||||
draft: true
|
||||
menu:
|
||||
platform:
|
||||
name: Hinted Handoff Queue buildup
|
||||
parent: Troubleshoot
|
||||
weight: 3
|
||||
---
|
||||
|
||||
_PLACEHOLDER_
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
---
|
||||
title: Troubleshooting IOPS
|
||||
description: placeholder
|
||||
draft: true
|
||||
menu:
|
||||
platform:
|
||||
name: IOPS
|
||||
parent: Troubleshoot
|
||||
weight: 5
|
||||
---
|
||||
|
||||
_PLACEHOLDER_
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
---
|
||||
title: Troubleshooting with log analysis
|
||||
description: placeholder
|
||||
draft: true
|
||||
menu:
|
||||
platform:
|
||||
name: Log analysis
|
||||
parent: Troubleshoot
|
||||
weight: 6
|
||||
---
|
||||
|
||||
_PLACEHOLDER_
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
---
|
||||
title: Troubleshooting the volume of reads and writes
|
||||
description: placeholder
|
||||
draft: true
|
||||
menu:
|
||||
platform:
|
||||
name: Volume of reads and writes
|
||||
parent: Troubleshoot
|
||||
weight: 7
|
||||
---
|
||||
|
||||
_PLACEHOLDER_
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
---
|
||||
title: Troubleshooting runaway series cardinality
|
||||
description: placeholder
|
||||
draft: true
|
||||
menu:
|
||||
platform:
|
||||
name: Runaway series cardinality
|
||||
parent: Troubleshoot
|
||||
weight: 2
|
||||
---
|
||||
|
||||
_PLACEHOLDER_
|
||||
Loading…
Reference in New Issue