From fe20a432cbb2873350b1da7be488599e7f4c2c65 Mon Sep 17 00:00:00 2001 From: nbaenam Date: Mon, 26 Aug 2024 11:40:37 +0200 Subject: [PATCH 1/5] feat(K8s): Added the configuration-guided step to the installation K8s doc --- .../installation/reduce-ingest.mdx | 2 +- .../kubernetes-plugin-log-forwarding.mdx | 33 --------------- src/install/config/kubernetes.yaml | 7 ++++ .../guided/configuration-guided.mdx | 40 +++++++++++++++++++ .../kubernetes/guided/install-guided.mdx | 11 +---- 5 files changed, 49 insertions(+), 44 deletions(-) create mode 100644 src/install/kubernetes/guided/configuration-guided.mdx diff --git a/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/reduce-ingest.mdx b/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/reduce-ingest.mdx index ff717f40f26..2811dfa8d51 100644 --- a/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/reduce-ingest.mdx +++ b/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/reduce-ingest.mdx @@ -27,7 +27,7 @@ Let's explain each option. If you're looking to cut costs, you can modify the `global.lowDataMode` parameter value. This will cut down on the number of metrics you send. The modification of this parameter will depend on the method you used to install Kubernetes: -* **Guided install** (New Relic CLI, Helm, manifest). The installation command includes `lowDataMode` by default because it has these parameters: `NRI_CLI_LOW_DATA_MODE`, `NRI_CLI_PROMETHEUS_AGENT_LOW_DATA_MODE`, and `NRI_CLI_LOGGING_LOW_DATA_MODE`. +* **Guided install** (New Relic CLI, Helm, manifest). The installation command includes `lowDataMode` by default because it has these parameters: `NR_CLI_LOW_DATA_MODE`, `NR_CLI_PROMETHEUS_AGENT_LOW_DATA_MODE`, and `NR_CLI_LOGGING_LOW_DATA_MODE`. * **Helm**. Set the `global.lowDataMode` parameter in the [`nri-bundle` chart](https://github.com/newrelic/helm-charts/tree/master/charts/nri-bundle) to true. diff --git a/src/content/docs/logs/forward-logs/kubernetes-plugin-log-forwarding.mdx b/src/content/docs/logs/forward-logs/kubernetes-plugin-log-forwarding.mdx index b4ed4c36d9e..3ad53520430 100644 --- a/src/content/docs/logs/forward-logs/kubernetes-plugin-log-forwarding.mdx +++ b/src/content/docs/logs/forward-logs/kubernetes-plugin-log-forwarding.mdx @@ -18,39 +18,6 @@ freshnessValidatedDate: never New Relic's Kubernetes plugin for log forwarding simplifies sending logs from your cluster to New Relic logs. It uses a standalone Docker image and runs as a DaemonSet, seamlessly collecting logs for centralized analysis and troubleshooting. Forwarding your Kubernetes logs to New Relic will give you enhanced capabilities to collect, process, explore, query, and alert on your log data. -## Enable Kubernetes for log management [#enable-process] - -To forward your Kubernetes logs to New Relic with our plugin: - -1. [Install the New Relic Kubernetes integration](/install/kubernetes). This integration includes the Kubernetes plugin for logs. - -2. Optionally, you can further tune your installation in [the guided install](/install/kubernetes) using the numerous configuration options available in the [`newrelic-logging` repository](https://github.com/newrelic/helm-charts/tree/master/charts/newrelic-logging#configuration). However, we recommend the standard setup, as it's valid for most users. - - Guided install from the UI - -
- Go to **[one.newrelic.com](https://one.newrelic.com/) > Integrations & Agents** and click the **Guided install** tile. Then select **Kubernetes** and **Guided**. -
- - - - If you're [using a Kubernetes secret](https://github.com/newrelic/helm-charts/blob/master/charts/newrelic-logging/values.yaml#L8-L25) to store the New Relic , the `newrelic-logging` chart defaults to sending logs to the US API endpoint. If the license key belongs to an EU or FedRAMP account, and a secret is used for key storage, you must update the endpoint setting with the appropriate value from the [API reference docs](/docs/logs/log-api/introduction-log-api/#endpoint). Here's an example of how to set this for EU accounts: - - ```yml - newrelic-logging: - enabled: true - endpoint: https://log-api.eu.newrelic.com/log/v1 - ``` - - -3. Generate some traffic and wait a few minutes, then [check your account](#find-data) for data. - - - ## Fluent Bit output plugin [#fluent-bit] New Relic has a [Fluent Bit](https://fluentbit.io/) [output plugin](https://github.com/newrelic/newrelic-fluent-bit-output) to forward your logs to New Relic log management. This plugin is also provided in a standalone Docker image that can be installed in a Kubernetes cluster in the form of a DaemonSet, also known as the Kubernetes plugin. diff --git a/src/install/config/kubernetes.yaml b/src/install/config/kubernetes.yaml index 918e55e4e00..ba787f37177 100644 --- a/src/install/config/kubernetes.yaml +++ b/src/install/config/kubernetes.yaml @@ -53,6 +53,13 @@ steps: - optionType: dropdown1 options: - value: 'manifest' + - filePath: 'src/install/kubernetes/guided/configuration-guided.mdx' + overrides: + - isConditionalStep: true + selectedOptions: + - optionType: dropdown1 + options: + - value: 'guided' - filePath: 'src/install/kubernetes/helm/configuration-helm.mdx' overrides: - isConditionalStep: true diff --git a/src/install/kubernetes/guided/configuration-guided.mdx b/src/install/kubernetes/guided/configuration-guided.mdx new file mode 100644 index 00000000000..0e374836b82 --- /dev/null +++ b/src/install/kubernetes/guided/configuration-guided.mdx @@ -0,0 +1,40 @@ +--- +componentType: default +headingText: Gather log data +--- + +This step allows you to forward your Kubernetes logs to New Relic using our plugin. We recommend the default setup, as it's what most users will need. + + Guided install from the UI + +Select one of these options: + + * **Forward all logs with full enrichment**: It associates all Kubernetes metadata with each log record. This option will increase your ingested data and your cost. + + * **Forward all logs with minimal enrichment (low data mode)**: It sets the `NR_CLI_LOW_DATA_MODE` to true. This is the default option for reducing the amount of data ingested. See [Reduce data ingested by setting `global.lowDataMode`](/docs/kubernetes-pixie/kubernetes-integration/installation/reduce-ingest/#reduce-data-ingest) for more info. + + + + If you're [using a Kubernetes secret](https://github.com/newrelic/helm-charts/blob/master/charts/newrelic-logging/values.yaml#L8-L25) to store the New Relic , the `newrelic-logging` chart defaults to sending logs to the US API endpoint. If the license key belongs to an EU or FedRAMP account, and a secret is used for key storage, you must update the endpoint setting with the appropriate value from the [API reference docs](/docs/logs/log-api/introduction-log-api/#endpoint). Here's an example of how to set this for EU accounts: + + ```yml + newrelic-logging: + enabled: true + endpoint: https://log-api.eu.newrelic.com/log/v1 + ``` + + +At the end, you'll have the command that you need to copy and paste into a terminal. + + +Guided install from the UI + + diff --git a/src/install/kubernetes/guided/install-guided.mdx b/src/install/kubernetes/guided/install-guided.mdx index 41637b06f51..3c43bcf5def 100644 --- a/src/install/kubernetes/guided/install-guided.mdx +++ b/src/install/kubernetes/guided/install-guided.mdx @@ -21,13 +21,4 @@ Choose one of these instrumentation methods: /> -Whichever option you choose, you'll go through several steps. Fill in the fields that apply to you. Follow the instructions on each screen. At the end, you'll have the command that you need to copy and paste into a terminal. - - -Guided install from the UI - +Whichever option you choose, you'll go through several steps. Fill in the fields that apply to you. Follow the instructions on each screen. From 82e2e2087ed44c99d3dfc204f2a65dc33c57679a Mon Sep 17 00:00:00 2001 From: nbaenam Date: Wed, 4 Sep 2024 12:15:07 +0200 Subject: [PATCH 2/5] fix(K8s): Added TW comments --- .../install-configure-prometheus-agent/migration-guide.mdx | 2 +- .../auto-telemetry-pixie/pixie-data-security-overview.mdx | 2 +- .../advanced-configuration/enable-fedramp-endpoints.mdx | 4 ++-- .../advanced-configuration/windows-linux-hybrid-cluster.mdx | 6 +++--- .../logs/forward-logs/kubernetes-plugin-log-forwarding.mdx | 4 ++-- .../contribute-nr-io/build-quickstart/add-alerts.mdx | 2 +- src/install/kubernetes/guided/install-guided.mdx | 2 +- src/install/kubernetes/manifest/install-manifest.mdx | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/content/docs/infrastructure/prometheus-integrations/install-configure-prometheus-agent/migration-guide.mdx b/src/content/docs/infrastructure/prometheus-integrations/install-configure-prometheus-agent/migration-guide.mdx index c2193369b64..96520011def 100644 --- a/src/content/docs/infrastructure/prometheus-integrations/install-configure-prometheus-agent/migration-guide.mdx +++ b/src/content/docs/infrastructure/prometheus-integrations/install-configure-prometheus-agent/migration-guide.mdx @@ -196,7 +196,7 @@ Prometheus OpenMetrics, `nri-prometheus`, transformations are now replaced with ## Self-instrumentation [#self-instrumentation] -Similar to Prometheus OpenMetrics (`nri-prometheus`), the Prometheus agent (`newrelic-prometheus-agent`) self-scrapes internal metrics. These metrics have the `prometheus_` prefix and you can use them to observe the status of the Prometheus instance. By default, only a reduced set of these metrics are sent. You can find the list of metrics on the [default values.yaml file](https://github.com/newrelic/newrelic-prometheus-configurator/blob/main/charts/newrelic-prometheus-agent/values.yaml) of the chart, by searching for `job_name: self-metrics`. +Similar to Prometheus OpenMetrics (`nri-prometheus`), the Prometheus agent (`newrelic-prometheus-agent`) self-scrapes internal metrics. These metrics have the `prometheus_` prefix and you can use them to observe the status of the Prometheus instance. By default, only a reduced set of these metrics are sent. You can find the list of metrics on the [default `values.yaml` file](https://github.com/newrelic/newrelic-prometheus-configurator/blob/main/charts/newrelic-prometheus-agent/values.yaml) of the chart, by searching for `job_name: self-metrics`. We also give you a curated dashboard for self-metrics with performance and health information, and also metrics volume sent. Install the quickstart containing the [dashboard for the Prometheus agent](https://newrelic.com/instant-observability/prometheus-agent) in your New Relic account. diff --git a/src/content/docs/kubernetes-pixie/auto-telemetry-pixie/pixie-data-security-overview.mdx b/src/content/docs/kubernetes-pixie/auto-telemetry-pixie/pixie-data-security-overview.mdx index bb2b07d7009..6e7bd3887c6 100644 --- a/src/content/docs/kubernetes-pixie/auto-telemetry-pixie/pixie-data-security-overview.mdx +++ b/src/content/docs/kubernetes-pixie/auto-telemetry-pixie/pixie-data-security-overview.mdx @@ -59,7 +59,7 @@ By default, Pixie queries withpixie.ai to check if new updates have been pushed id="" title="newrelic-manifest.yaml option" > - in your newrelic-manifest.yaml file under the pl-cluster-config section, add `PL_DISABLE_AUTO_UPDATE: "true"` to the `data` directive. Example: + In your `newrelic-manifest.yaml` file under the pl-cluster-config section, add `PL_DISABLE_AUTO_UPDATE: "true"` to the `data` directive. Example: ``` --- diff --git a/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/enable-fedramp-endpoints.mdx b/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/enable-fedramp-endpoints.mdx index 37b0bc316bc..68ee259606a 100644 --- a/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/enable-fedramp-endpoints.mdx +++ b/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/enable-fedramp-endpoints.mdx @@ -33,7 +33,7 @@ helm upgrade --install newrelic-bundle newrelic/nri-bundle \  --set global.fedramp.enabled=true ``` -If using a values.yaml file for your installation, you would enable the same parameter. +If using a `values.yaml` file for your installation, you would enable the same parameter. ```yaml ... @@ -43,7 +43,7 @@ global: ... ``` -The full `nri-bundle` values.yaml file example can be found [here](https://github.com/newrelic/helm-charts/blob/master/charts/nri-bundle/values.yaml). +The full `nri-bundle` `values.yaml` file example can be found [here](https://github.com/newrelic/helm-charts/blob/master/charts/nri-bundle/values.yaml). ### Manifest [#manifest] diff --git a/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/windows-linux-hybrid-cluster.mdx b/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/windows-linux-hybrid-cluster.mdx index bf52449e00c..fe1970f4959 100644 --- a/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/windows-linux-hybrid-cluster.mdx +++ b/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/windows-linux-hybrid-cluster.mdx @@ -34,7 +34,7 @@ To use this integration, you should: Create a Yaml file that defines your values. This file defines the different subcharts that Helm will install and then assigns values to them. - An example of a yaml file that you could name `values.yaml` is this: + An example of a YAML file that you could name `values.yaml` is this: ```yaml global: @@ -81,7 +81,7 @@ To use this integration, you should: Here are some important things to keep in mind: - * Other subcharts may exist in `nri-bundle` that are not represented in this file. If you'd like to add those subcharts, then add their key or value pairs to your yaml file. + * Other subcharts may exist in `nri-bundle` that are not represented in this file. If you'd like to add those subcharts, then add their key or value pairs to your YAML file. * The `newrelic/nri-bundle` chart contains the latest updates for Linux-based nodes. * You can also configure the `newrelic-logging` chart during this step to install to both Linux and Windows nodes. * You must configure a `NodeSelector` to avoid scheduling to Windows. If an installation fails on a mixed cluster using default values from guided install, add the `nodeSelector` values. @@ -102,7 +102,7 @@ To use this integration, you should: ### Define `newrelic-infrastructure` for Windows nodes [#newrelic-infra] - Create a second yaml file to add values for the `newrelic-infrastructure` v2 chart. This is a separate yaml file from the one you created in step one. This is an example yaml file for `newrelic-infrastructure` that you could name `windows-values.yaml`: + Create a second YAML file to add values for the `newrelic-infrastructure` v2 chart. This is a separate YAML file from the one you created in step one. This is an example YAML file for `newrelic-infrastructure` that you could name `windows-values.yaml`: ```yaml global: diff --git a/src/content/docs/logs/forward-logs/kubernetes-plugin-log-forwarding.mdx b/src/content/docs/logs/forward-logs/kubernetes-plugin-log-forwarding.mdx index 3ad53520430..55c778d0fef 100644 --- a/src/content/docs/logs/forward-logs/kubernetes-plugin-log-forwarding.mdx +++ b/src/content/docs/logs/forward-logs/kubernetes-plugin-log-forwarding.mdx @@ -20,9 +20,9 @@ New Relic's Kubernetes plugin for log forwarding simplifies sending logs from yo ## Fluent Bit output plugin [#fluent-bit] -New Relic has a [Fluent Bit](https://fluentbit.io/) [output plugin](https://github.com/newrelic/newrelic-fluent-bit-output) to forward your logs to New Relic log management. This plugin is also provided in a standalone Docker image that can be installed in a Kubernetes cluster in the form of a DaemonSet, also known as the Kubernetes plugin. +New Relic has a [Fluent Bit output plugin](https://github.com/newrelic/newrelic-fluent-bit-output) to forward your logs to New Relic log management. This plugin is also provided in a standalone Docker image that can be installed in a Kubernetes cluster in the form of a DaemonSet, also known as the Kubernetes plugin. -See [Fluent Bit plugin for log forwarding](/docs/logs/forward-logs/fluent-bit-plugin-log-forwarding) for more details about it. +See [Fluent Bit plugin for log forwarding](/docs/logs/forward-logs/fluent-bit-plugin-log-forwarding) doc for more details about it. ### Additional metric details [#addition-metric-details] diff --git a/src/content/docs/new-relic-solutions/build-nr-ui/contribute-nr-io/build-quickstart/add-alerts.mdx b/src/content/docs/new-relic-solutions/build-nr-ui/contribute-nr-io/build-quickstart/add-alerts.mdx index 5aad43ae109..8c5840d330c 100644 --- a/src/content/docs/new-relic-solutions/build-nr-ui/contribute-nr-io/build-quickstart/add-alerts.mdx +++ b/src/content/docs/new-relic-solutions/build-nr-ui/contribute-nr-io/build-quickstart/add-alerts.mdx @@ -24,7 +24,7 @@ In a previous procedure, you [created alerts](/docs/new-relic-solutions/build-nr Here, copy `alert-policies/example-alert-policy` directory and its content to `alert-policies` directory at the root level. Rename the directory as `flashdb`. - This directory contains sample YAML files for static and baseline alerts to contribute the corresponding alerts to New Relic I/O. To help you populate your yaml files, you can use New Relic's [NerdGraph API explorer](https://api.newrelic.com/graphiql) to get a JSON representation of each alert condition. + This directory contains sample YAML files for static and baseline alerts to contribute the corresponding alerts to New Relic I/O. To help you populate your YAML files, you can use New Relic's [NerdGraph API explorer](https://api.newrelic.com/graphiql) to get a JSON representation of each alert condition. NerdGraph is New Relic's GraphQL API. diff --git a/src/install/kubernetes/guided/install-guided.mdx b/src/install/kubernetes/guided/install-guided.mdx index 3c43bcf5def..cf982c7cc2d 100644 --- a/src/install/kubernetes/guided/install-guided.mdx +++ b/src/install/kubernetes/guided/install-guided.mdx @@ -11,7 +11,7 @@ Choose one of these instrumentation methods: * **Guided**: It automates your installation by running a simple script. * **Helm**: A Helm chart values file with pre-populated required parameters. -* **Manifest**: A manifest yaml file with pre-populated required parameters. +* **Manifest**: A manifest YAML file with pre-populated required parameters. Date: Mon, 9 Sep 2024 11:50:56 +0200 Subject: [PATCH 3/5] style(K8s): Added TW comments --- .../logs/forward-logs/fluent-bit-plugin-log-forwarding.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/content/docs/logs/forward-logs/fluent-bit-plugin-log-forwarding.mdx b/src/content/docs/logs/forward-logs/fluent-bit-plugin-log-forwarding.mdx index 8ab3e2b7eb4..27f2625a671 100644 --- a/src/content/docs/logs/forward-logs/fluent-bit-plugin-log-forwarding.mdx +++ b/src/content/docs/logs/forward-logs/fluent-bit-plugin-log-forwarding.mdx @@ -73,15 +73,15 @@ To upgrade, follow the [installation instructions](#fluentbit-plugin) or grab th ## Install Fluent Bit output plugin [#fluent-bit] -New Relic has a [Fluent Bit](https://fluentbit.io/) [output plugin](https://github.com/newrelic/newrelic-fluent-bit-output) to forward your logs to New Relic log management. This plugin is also provided in a standalone Docker image that can be installed in a Kubernetes cluster in the form of a DaemonSet, also known as the Kubernetes plugin. +New Relic has a [[Fluent Bit output plugin](https://github.com/newrelic/newrelic-fluent-bit-output) to forward your logs to New Relic log management. This plugin is also provided in a standalone Docker image that can be installed in a Kubernetes cluster in the form of a DaemonSet, also known as the Kubernetes plugin. You can install it in your cluster using our Helm chart in two ways. ### Use our guided install [#helm-guided-install] -Although the [newrelic-logging](https://github.com/newrelic/helm-charts/tree/master/charts/newrelic-logging) chart works as a standalone, we recommend installing it as part of the [nri-bundle](https://github.com/newrelic/helm-charts/tree/master/charts/nri-bundle) chart. +Although the [newrelic-logging](https://github.com/newrelic/helm-charts/tree/master/charts/newrelic-logging) chart works as a standalone, we recommend installing it as part of the [`nri-bundle`](https://github.com/newrelic/helm-charts/tree/master/charts/nri-bundle) chart. -The best way to install this is through our [guided installation](/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-integration-install-configure/) process. This guided install can generate the Helm 3 commands required to install it ([see "Helm 3"](/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-integration-install-configure/#finish-your-install)). +The best way to install this is through our [guided installation](/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-integration-install-configure/) process. This guided install can generate the Helm 3 commands required to install it ([see `Helm 3`](/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-integration-install-configure/#finish-your-install)). ### Manual installation [#manual-helm-install] From a05d65a205290105503605ad21812cce11365cba Mon Sep 17 00:00:00 2001 From: nbaenam Date: Thu, 12 Sep 2024 14:59:42 +0200 Subject: [PATCH 4/5] fix(K8s): Added TW comments --- .../advanced-configuration/windows-linux-hybrid-cluster.mdx | 4 ++-- .../logs/forward-logs/fluent-bit-plugin-log-forwarding.mdx | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/windows-linux-hybrid-cluster.mdx b/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/windows-linux-hybrid-cluster.mdx index fe1970f4959..e25baecee12 100644 --- a/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/windows-linux-hybrid-cluster.mdx +++ b/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/windows-linux-hybrid-cluster.mdx @@ -32,7 +32,7 @@ To use this integration, you should: ### Define your subcharts [#install-chart-bundle] - Create a Yaml file that defines your values. This file defines the different subcharts that Helm will install and then assigns values to them. + Create a YAML file that defines your values. This file defines the different subcharts that Helm will install and then assigns values to them. An example of a YAML file that you could name `values.yaml` is this: @@ -81,7 +81,7 @@ To use this integration, you should: Here are some important things to keep in mind: - * Other subcharts may exist in `nri-bundle` that are not represented in this file. If you'd like to add those subcharts, then add their key or value pairs to your YAML file. + * Other subcharts may exist in `nri-bundle` that are not represented in this file. If you'd like to add those subcharts, then add their key-value pairs to your YAML file. * The `newrelic/nri-bundle` chart contains the latest updates for Linux-based nodes. * You can also configure the `newrelic-logging` chart during this step to install to both Linux and Windows nodes. * You must configure a `NodeSelector` to avoid scheduling to Windows. If an installation fails on a mixed cluster using default values from guided install, add the `nodeSelector` values. diff --git a/src/content/docs/logs/forward-logs/fluent-bit-plugin-log-forwarding.mdx b/src/content/docs/logs/forward-logs/fluent-bit-plugin-log-forwarding.mdx index 27f2625a671..4e6ecee4ec8 100644 --- a/src/content/docs/logs/forward-logs/fluent-bit-plugin-log-forwarding.mdx +++ b/src/content/docs/logs/forward-logs/fluent-bit-plugin-log-forwarding.mdx @@ -73,7 +73,7 @@ To upgrade, follow the [installation instructions](#fluentbit-plugin) or grab th ## Install Fluent Bit output plugin [#fluent-bit] -New Relic has a [[Fluent Bit output plugin](https://github.com/newrelic/newrelic-fluent-bit-output) to forward your logs to New Relic log management. This plugin is also provided in a standalone Docker image that can be installed in a Kubernetes cluster in the form of a DaemonSet, also known as the Kubernetes plugin. +New Relic has a [Fluent Bit output plugin](https://github.com/newrelic/newrelic-fluent-bit-output) to forward your logs to New Relic log management. This plugin is also provided in a standalone Docker image that can be installed in a Kubernetes cluster in the form of a DaemonSet, also known as the Kubernetes plugin. You can install it in your cluster using our Helm chart in two ways. From f24ed338c1406d83887031a0cf74e244823dcd93 Mon Sep 17 00:00:00 2001 From: nbaenam Date: Wed, 18 Sep 2024 16:51:52 +0200 Subject: [PATCH 5/5] fix(K8s): Added SME and TW comments --- .../kubernetes-plugin-log-forwarding.mdx | 14 +++++++------- src/nav/kubernetes-pixie.yml | 2 +- src/nav/logs.yml | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/content/docs/logs/forward-logs/kubernetes-plugin-log-forwarding.mdx b/src/content/docs/logs/forward-logs/kubernetes-plugin-log-forwarding.mdx index 55c778d0fef..aa32034e21b 100644 --- a/src/content/docs/logs/forward-logs/kubernetes-plugin-log-forwarding.mdx +++ b/src/content/docs/logs/forward-logs/kubernetes-plugin-log-forwarding.mdx @@ -1,10 +1,10 @@ --- -title: Kubernetes plugin for log forwarding +title: Forward Kubernetes logs tags: - Logs - Enable log management in New Relic - Enable log monitoring in New Relic -metaDescription: 'Install and configure New Relic logging for Kubernetes, so you can use enhanced log management capabilities.' +metaDescription: 'Install and configure New Relic for Kubernetes, so you can use enhanced log management capabilities.' redirects: - /docs/enable-new-relic-logs-kubernetes - /docs/logs/new-relic-logs/enable-logs/enable-new-relic-logs-kubernetes @@ -16,11 +16,11 @@ freshnessValidatedDate: never --- -New Relic's Kubernetes plugin for log forwarding simplifies sending logs from your cluster to New Relic logs. It uses a standalone Docker image and runs as a DaemonSet, seamlessly collecting logs for centralized analysis and troubleshooting. Forwarding your Kubernetes logs to New Relic will give you enhanced capabilities to collect, process, explore, query, and alert on your log data. +Using the log forwarding of the Kubernetes integration, you can send logs from your cluster to New Relic logs. It uses a standalone Docker image and runs as a DaemonSet, seamlessly collecting logs for centralized analysis and troubleshooting. Forwarding your Kubernetes logs to New Relic will give you enhanced capabilities to collect, process, explore, query, and alert on your log data. ## Fluent Bit output plugin [#fluent-bit] -New Relic has a [Fluent Bit output plugin](https://github.com/newrelic/newrelic-fluent-bit-output) to forward your logs to New Relic log management. This plugin is also provided in a standalone Docker image that can be installed in a Kubernetes cluster in the form of a DaemonSet, also known as the Kubernetes plugin. +New Relic has a [Fluent Bit output plugin](https://github.com/newrelic/newrelic-fluent-bit-output) to forward your logs to New Relic log management. See [Fluent Bit plugin for log forwarding](/docs/logs/forward-logs/fluent-bit-plugin-log-forwarding) doc for more details about it. @@ -35,9 +35,9 @@ The `newrelic-logging` Helm chart uses [Fluent Bit](https://fluentbit.io/) toget * **[Internal plugin metrics from `newrelic-fluent-bit-output`](https://github.com/newrelic/newrelic-fluent-bit-output?tab=readme-ov-file#troubleshooting-metrics)**: Collected by the output plugin and sent to New Relic's metric API. These metrics only contain the `cluster_name` dimension, so they can be narrowed down to a particular cluster but not to a particular host or pod. They're useful to assess the overall latency when delivering the logs to the New Relic Logs API or to observe potential packaging problems. -## Troubleshoot your Kubernetes plugin for log forwarding installation [#troubleshoot-installation] +## Troubleshoot your Kubernetes for log forwarding installation [#troubleshoot-installation] -Sometimes, despite correctly installing the Kubernetes log forwarding plugin (`newrelic-logging` [Helm chart](https://github.com/newrelic/helm-charts/blob/master/charts/newrelic-logging)), you may encounter performance issues that affect the correct delivery of logs. In that case, it can help to look at the log forwarder's internal metrics to see if you can find the cause of the problem. +Sometimes, despite correctly installing the Kubernetes (`newrelic-logging` [Helm chart](https://github.com/newrelic/helm-charts/blob/master/charts/newrelic-logging)), you may encounter performance issues that affect the correct delivery of logs. In that case, it can help to look at the log forwarder's internal metrics to see if you can find the cause of the problem. The `newrelic-logging` Helm chart provides a configuration setting to enable the collection of such metrics for a given Kubernetes cluster. We also provide a JSON-formatted dashboard template to easily display all these metrics in New Relic. @@ -77,7 +77,7 @@ If you don't see any data after enabling our log management capabilities, follow ## Disable log forwarding [#disable] -To disable log forwarding capabilities, you can uninstall the Kubernetes plugin by following [these steps](/docs/kubernetes-pixie/kubernetes-integration/uninstall-kubernetes/). You do not need to do anything else in New Relic. +To disable log forwarding capabilities, you can uninstall the Kubernetes integration by following [these steps](/docs/kubernetes-pixie/kubernetes-integration/uninstall-kubernetes/). You do not need to do anything else in New Relic. ## Choose your next step [#next-steps] diff --git a/src/nav/kubernetes-pixie.yml b/src/nav/kubernetes-pixie.yml index af77e2d5f6b..dbdd637dfe5 100644 --- a/src/nav/kubernetes-pixie.yml +++ b/src/nav/kubernetes-pixie.yml @@ -67,7 +67,7 @@ pages: path: /docs/kubernetes-pixie/kubernetes-integration/understand-use-data/find-use-your-kubernetes-data - title: Kubernetes events path: /docs/kubernetes-pixie/kubernetes-integration/understand-use-data/kubernetes-events-integration - - title: Plugin for log forwarding + - title: Forward Kubernetes logs path: /docs/logs/forward-logs/kubernetes-plugin-log-forwarding - title: Set alerts on Kubernetes pages: diff --git a/src/nav/logs.yml b/src/nav/logs.yml index d39b88f9801..4e8a64374e1 100644 --- a/src/nav/logs.yml +++ b/src/nav/logs.yml @@ -44,7 +44,7 @@ pages: path: /docs/logs/forward-logs/google-cloud-platform-log-forwarding - title: Heroku log drains path: /docs/logs/forward-logs/heroku-log-forwarding - - title: Kubernetes plugin + - title: Forward Kubernetes logs path: /docs/logs/forward-logs/kubernetes-plugin-log-forwarding - title: Logstash plugin path: /docs/logs/forward-logs/logstash-plugin-log-forwarding