diff --git a/daprdocs/content/en/operations/monitoring/logging/logs.md b/daprdocs/content/en/operations/monitoring/logging/logs.md index 16c13bd17..b5b751cba 100644 --- a/daprdocs/content/en/operations/monitoring/logging/logs.md +++ b/daprdocs/content/en/operations/monitoring/logging/logs.md @@ -86,7 +86,7 @@ spec: ## Log collectors -If you run Dapr in a Kubernetes cluster, [Fluentd](https://www.fluentd.org/) is a popular container log collector. You can use Fluentd with a [json parser plugin](https://docs.fluentd.org/parser/json) to parse Dapr JSON formatted logs. This [how-to]({{< ref fluentd.md >}}) shows how to configure the Fleuntd in your cluster. +If you run Dapr in a Kubernetes cluster, [Fluentd](https://www.fluentd.org/) is a popular container log collector. You can use Fluentd with a [json parser plugin](https://docs.fluentd.org/parser/json) to parse Dapr JSON formatted logs. This [how-to]({{< ref fluentd.md >}}) shows how to configure the Fluentd in your cluster. If you are using the Azure Kubernetes Service, you can use the default OMS Agent to collect logs with Azure Monitor without needing to install Fluentd. diff --git a/daprdocs/content/en/operations/monitoring/logging/newrelic.md b/daprdocs/content/en/operations/monitoring/logging/newrelic.md new file mode 100644 index 000000000..cb0ab5d2b --- /dev/null +++ b/daprdocs/content/en/operations/monitoring/logging/newrelic.md @@ -0,0 +1,78 @@ +--- +type: docs +title: "How-To: Set-up New Relic for Dapr logging" +linkTitle: "New Relic" +weight: 2000 +description: "Set-up New Relic for Dapr logging" +--- + +## Prerequisites + +- Perpetually [free New Relic account](https://newrelic.com/signup?ref=dapr), 100 GB/month of free data ingest, 1 free full access user, unlimited free basic users + +## Background + +New Relic offers a [Fluent Bit](https://fluentbit.io/) output [plugin](https://github.com/newrelic/newrelic-fluent-bit-output) to easily forward your logs to [New Relic Logs](https://github.com/newrelic/newrelic-fluent-bit-output). This plugin is also provided in a standalone Docker image that can be installed in a Kubernetes cluster in the form of a DaemonSet, which we refer as the Kubernetes plugin. + +This document explains how to install it in your cluster, either using a Helm chart (recommended), or manually by applying Kubernetes manifests. + +## Installation + +### Install using the Helm chart (recommended) + +1. Install Helm following the official instructions. + +2. Add the New Relic official Helm chart repository following these instructions + +3. Run the following command to install the New Relic Logging Kubernetes plugin via Helm, replacing the placeholder value YOUR_LICENSE_KEY with your [New Relic license key](https://docs.newrelic.com/docs/accounts/install-new-relic/account-setup/license-key): + +- Helm 3 + ```bash + helm install newrelic-logging newrelic/newrelic-logging --set licenseKey=YOUR_LICENSE_KEY + ``` + +- Helm 2 + ```bash + helm install newrelic/newrelic-logging --name newrelic-logging --set licenseKey=YOUR_LICENSE_KEY + ``` + +For EU users, add `--set endpoint=https://log-api.eu.newrelic.com/log/v1 to any of the helm install commands above. + +By default, tailing is set to /var/log/containers/*.log. To change this setting, provide your preferred path by adding --set fluentBit.path=DESIRED_PATH to any of the helm install commands above. + +### Install the Kubernetes manifest + +1. Download the following 3 manifest files into your current working directory: + + ```bash + curl https://raw.githubusercontent.com/newrelic/helm-charts/master/charts/newrelic-logging/k8s/fluent-conf.yml > fluent-conf.yml + curl https://raw.githubusercontent.com/newrelic/helm-charts/master/charts/newrelic-logging/k8s/new-relic-fluent-plugin.yml > new-relic-fluent-plugin.yml + curl https://raw.githubusercontent.com/newrelic/helm-charts/master/charts/newrelic-logging/k8s/rbac.yml > rbac.yml + ``` + +2. In the downloaded new-relic-fluent-plugin.yml file, replace the placeholder value LICENSE_KEY with your New Relic license key. + + For EU users, replace the ENDPOINT environment variable to https://log-api.eu.newrelic.com/log/v1. + +3. Once the License key has been added, run the following command in your terminal or command-line interface: + ```bash + kubectl apply -f . + ``` + +4. [OPTIONAL] You can configure how the plugin parses the data by editing the parsers.conf section in the fluent-conf.yml file. For more information, see Fluent Bit's documentation on Parsers configuration. + + By default, tailing is set to /var/log/containers/*.log. To change this setting, replace the default path with your preferred path in the new-relic-fluent-plugin.yml file. + +## View Logs + +![Dapr Annotations](/images/nr-logging-1.png) + +![Search](/images/nr-logging-2.png) + +## Related Links/References + +* [New Relic Account Signup](https://newrelic.com/signup) +* [Telemetry Data Platform](https://newrelic.com/platform/telemetry-data-platform) +* [New Relic Logging](https://github.com/newrelic/helm-charts/tree/master/charts/newrelic-logging) +* [Types of New Relic API keys](https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys) +* [Alerts and Applied Intelligence](https://docs.newrelic.com/docs/alerts-applied-intelligence) diff --git a/daprdocs/content/en/operations/monitoring/metrics/newrelic.md b/daprdocs/content/en/operations/monitoring/metrics/newrelic.md new file mode 100644 index 000000000..567d7dcd1 --- /dev/null +++ b/daprdocs/content/en/operations/monitoring/metrics/newrelic.md @@ -0,0 +1,43 @@ +--- +type: docs +title: "How-To: Set-up New Relic to collect and analyze metrics" +linkTitle: "New Relic" +weight: 6000 +description: "Set-up New Relic for Dapr metrics" +--- + +## Prerequisites + +- Perpetually [free New Relic account](https://newrelic.com/signup?ref=dapr), 100 GB/month of free data ingest, 1 free full access user, unlimited free basic users + +## Background + +New Relic offers a Prometheus OpenMetrics Integration. + +This document explains how to install it in your cluster, either using a Helm chart (recommended). + +## Installation + +1. Install Helm following the official instructions. + +2. Add the New Relic official Helm chart repository following [these instructions](https://github.com/newrelic/helm-charts/blob/master/README.md#installing-charts) + +3. Run the following command to install the New Relic Logging Kubernetes plugin via Helm, replacing the placeholder value YOUR_LICENSE_KEY with your [New Relic license key](https://docs.newrelic.com/docs/accounts/install-new-relic/account-setup/license-key): + + ```bash + helm install nri-prometheus newrelic/nri-prometheus --set licenseKey=YOUR_LICENSE_KEY + ``` + +## View Metrics + +![Dapr Metrics](/images/nr-metrics-1.png) + +![Dashboard](/images/nr-dashboard-dapr-metrics-1.png) + +## Related Links/References + +* [New Relic Account Signup](https://newrelic.com/signup) +* [Telemetry Data Platform](https://newrelic.com/platform/telemetry-data-platform) +* [New Relic Prometheus OpenMetrics Integration](https://github.com/newrelic/helm-charts/tree/master/charts/nri-prometheus) +* [Types of New Relic API keys](https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys) +* [Alerts and Applied Intelligence](https://docs.newrelic.com/docs/alerts-applied-intelligence) diff --git a/daprdocs/content/en/operations/monitoring/tracing/supported-tracing-backends/newrelic.md b/daprdocs/content/en/operations/monitoring/tracing/supported-tracing-backends/newrelic.md index 4d44295d2..d2cb50fb3 100644 --- a/daprdocs/content/en/operations/monitoring/tracing/supported-tracing-backends/newrelic.md +++ b/daprdocs/content/en/operations/monitoring/tracing/supported-tracing-backends/newrelic.md @@ -1,14 +1,14 @@ --- type: docs -title: "How-To: Set-up New Relic for Dapr observability" +title: "How-To: Set-up New Relic for distributed tracing" linkTitle: "New Relic" weight: 2000 -description: "Set-up New Relic for Dapr observability" +description: "Set-up New Relic for distributed tracing" --- ## Prerequisites -- Perpetually [free New Relic account](https://newrelic.com/signup), 100 GB/month of free data ingest, 1 free full access user, unlimited free basic users +- Perpetually [free New Relic account](https://newrelic.com/signup?ref=dapr), 100 GB/month of free data ingest, 1 free full access user, unlimited free basic users ## Configure Dapr tracing diff --git a/daprdocs/static/images/nr-logging-1.png b/daprdocs/static/images/nr-logging-1.png new file mode 100644 index 000000000..71712364d Binary files /dev/null and b/daprdocs/static/images/nr-logging-1.png differ diff --git a/daprdocs/static/images/nr-logging-2.png b/daprdocs/static/images/nr-logging-2.png new file mode 100644 index 000000000..c57b0cda6 Binary files /dev/null and b/daprdocs/static/images/nr-logging-2.png differ diff --git a/daprdocs/static/images/nr-metrics-1.png b/daprdocs/static/images/nr-metrics-1.png new file mode 100644 index 000000000..200f875e7 Binary files /dev/null and b/daprdocs/static/images/nr-metrics-1.png differ