diff --git a/.gitignore b/.gitignore index 6b33796cda..3f9b773504 100644 --- a/.gitignore +++ b/.gitignore @@ -14,3 +14,4 @@ package-lock.json .hugo_build.lock .vscode/ .DS_Store +.idea diff --git a/content/integrate/datadog-with-redis-cloud/_index.md b/content/integrate/datadog-with-redis-cloud/_index.md new file mode 100644 index 0000000000..54dd440094 --- /dev/null +++ b/content/integrate/datadog-with-redis-cloud/_index.md @@ -0,0 +1,91 @@ +--- +LinkTitle: Datadog with Redis Cloud +Title: Datadog with Redis Cloud +alwaysopen: false +categories: +- docs +- integrate +- rs +description: To collect, view, and monitor metrics data from your databases and other + cluster components, you can connect Datadog to your Redis Cloud cluster using the + Redis Datadog Integration. +group: observability +summary: To collect, view, and monitor metrics data from your databases and other + cluster components, you can connect Datadog to your Redis Cloud cluster using the + Redis Datadog Integration. +type: integration +weight: 7 +--- + + +[Datadog](https://www.datadoghq.com/) is used by organizations of all sizes and across a wide range of industries to +enable digital transformation and cloud migration, drive collaboration among development, operations, security and +business teams, accelerate time to market for applications, reduce time to problem resolution, secure applications and +infrastructure, understand user behavior, and track key business metrics. + +The Datadog Integration for Redis Cloud uses the Datadog Integration API to connect to Redis metrics exporters. +The integration is based on Datadog's +[OpenMetrics integration](https://datadoghq.dev/integrations-core/base/openmetrics/) in their core API. This integration +enables Redis Cloud users to export metrics directly to Datadog for analysis, and includes Redis-designed +dashboards for use in monitoring Redis Cloud clusters. + +This integration makes it possible to: +- Collect and display metrics not available in the admin console +- Set up automatic alerts for node or cluster events +- Display these metrics alongside data from other systems + +{{< image filename="/images/rc/redis-cloud-datadog.png" alt="screenshot of datadog dashboard">}} +## Install Redis' Datadog Integration for Redis Cloud + +Installing the Datadog integration is a two-step process. Firstly, the installation must be part of your configuration. +Select 'Integrations' from the menu in the Datadog portal and then enter 'Redis' in the search bar, then select +'Redis Cloud by Redis, Inc.'. Next click 'Install Integration' in the top-right corner of the overview page. + +If you have not already created a VPC between the Redis Cloud cluster and the network in which the machine hosting the +Datadog agent lives you should do so now. Please visit [VPC Peering](https://redis.io/docs/latest/operate/rc/security/vpc-peering/) +and follow the instructions for the cloud platform of your choice. + +Returning to the Datadog console, open the 'Configure' tab of the integration and follow the instructions for installing +the integration on the local machine. After it has been installed follow the instruction for adding an instance to the +conf.yaml in /etc/datadog-agent/conf.d/redis_cloud.d. + +After you have edited the conf.yaml file please restart the service and check its status: + +```shell +sudo service datadog-agent restart +``` + +followed by: + +```shell +sudo service datadog-agent status +``` + +to be certain that the service itself is running and did not encounter any problems. Next, check the output of the +service; in the terminal on the Datadog agent host run the following command: + +```shell +tail -f /var/log/datadog/agent.log +``` + +It will take several minutes for data to reach Datadog. Finally, check the Datadog console by selecting +Infrastructure -> Host Map from the menu and then finding the host that is monitoring the Redis Cloud instance. The host +should be present, and in its list of components there should be a section called 'rdsc', which is the namespace used by +the Redis Cloud integration, although this can take several minutes to appear. It is also possible to verify the metrics +by choosing Metrics -> Explorer from the menu and entering 'rdsc.bdb_up'. + +## View metrics + +The Redis Cloud Integration for Datadog contains pre-defined dashboards to aid in monitoring your Redis Cloud deployment. + +The following dashboards are currently available: + +- Overview +- Database +- Network + +A number of additional dashboards will be included in the next release (v1.1.0). + +## Monitor metrics + +See [Observability and monitoring guidance]({{< relref "/integrate/prometheus-with-redis-enterprise/observability/" >}}) for monitoring details. diff --git a/content/integrate/datadog-with-redis-enterprise/_index.md b/content/integrate/datadog-with-redis-enterprise/_index.md new file mode 100644 index 0000000000..feb9eaa5ad --- /dev/null +++ b/content/integrate/datadog-with-redis-enterprise/_index.md @@ -0,0 +1,89 @@ +--- +LinkTitle: Datadog with Redis Enterprise +Title: Datadog with Redis Enterprise +alwaysopen: false +categories: +- docs +- integrate +- rs +description: To collect, view, and monitor metrics data from your databases and other + cluster components, you can connect Datadog to your Redis Enterprise cluster using + the Redis Datadog Integration. +group: observability +summary: To collect, view, and monitor metrics data from your databases and other + cluster components, you can connect Datadog to your Redis Enterprise cluster using + the Redis Datadog Integration. +type: integration +weight: 7 +--- + + +[Datadog](https://www.datadoghq.com/) is used by organizations of all sizes and across a wide range of industries to +enable digital transformation and cloud migration, drive collaboration among development, operations, security and +business teams, accelerate time to market for applications, reduce time to problem resolution, secure applications and +infrastructure, understand user behavior, and track key business metrics. + +The Datadog Integration for Redis Enterprise uses Datadog's Integration API to connect to Redis metrics exporters. +The integration is based on the Datadog +[OpenMetrics integration](https://datadoghq.dev/integrations-core/base/openmetrics/) in their core API. This integration +enables Redis Enterprise users to export metrics directly to Datadog for analysis, and includes Redis-designed +dashboards for use in monitoring Redis Enterprise clusters. + +This integration makes it possible to: +- Collect and display metrics not available in the admin console +- Set up automatic alerts for node or cluster events +- Display these metrics alongside data from other systems + +{{< image filename="/images/rc/redis-cloud-datadog.png" >}} +## Install Redis' Datadog Integration for Redis Enterprise + +Installing the Datadog integration is a two-step process. Firstly, the installation must be part of your configuration. +Select 'Integrations' from the menu in the Datadog portal and then enter 'Redis' in the search bar, then select +'Redis Enterprise by Redis, Inc.'. Next click 'Install Integration' in the top-right corner of the overview page. +Once it has been installed follow the instructions for adding an instance to the conf.yaml in +/etc/datadog-agent/conf.d/redis_cloud.d. + +After you have edited the conf.yaml file please restart the service and check its status: + +```shell +sudo service datadog-agent restart +``` + +followed by: + +```shell +sudo service datadog-agent status +``` + +to be certain that the service itself is running and did not encounter any problems. Next, check the output of the +service; in the terminal on the Datadog agent host run the following command: + +```shell +tail -f /var/log/datadog/agent.log +``` + +It will take several minutes for data to reach Datadog. Finally, check the Datadog console by selecting +Infrastructure -> Host Map from the menu and then finding the host that is monitoring the Redis Enterprise instance. The host +should be present, and in its list of components there should be a section called 'rdse', which is the namespace used by +the Redis Enterprise integration, although this can take several minutes to appear. It is also possible to verify the metrics +by choosing Metrics -> Explorer from the menu and entering 'rdse.bdb_up'. + +## View metrics + +The Redis Enterprise Integration for Datadog contains pre-defined dashboards to aid in monitoring your Redis Enterprise deployment. + +The following dashboards are currently available: + +- Overview +- Database +- Node +- Shard +- Active-Active +- Proxy +- Proxy Threads + + +## Monitor metrics + +See [Observability and monitoring guidance]({{< relref "/integrate/prometheus-with-redis-enterprise/observability/" >}}) for monitoring details. + diff --git a/content/integrate/dynatrace-with-redis-cloud/_index.md b/content/integrate/dynatrace-with-redis-cloud/_index.md new file mode 100644 index 0000000000..da87ff12f1 --- /dev/null +++ b/content/integrate/dynatrace-with-redis-cloud/_index.md @@ -0,0 +1,70 @@ +--- +Title: Dynatrace with Redis Cloud +LinkTitle: Dynatrace with Redis Cloud +categories: +- docs +- integrate +- rs +description: To collect, view, and monitor metrics data from your databases and other + cluster components, you can connect Dynatrace to your Redis Cloud cluster using + the Redis Dynatrace Integration. +group: observability +summary: To collect, view, and monitor metrics data from your databases and other + cluster components, you can connect Dynatrace to your Redis Cloud cluster using + the Redis Dynatrace Integration. +type: integration +weight: 7 +--- + + +[Dynatrace](https://www.dynatrace.com/) is used by organizations of all sizes and across a wide range of industries to +enable digital transformation and cloud migration, drive collaboration among development, operations, security and +business teams, accelerate time to market for applications, reduce time to problem resolution, secure applications and +infrastructure, understand user behavior, and track key business metrics. + +The Redis Dynatrace Integration for Redis Cloud uses Prometheus remote write functionality to connect Prometheus data +sources to Dynatrace. This integration enables Redis Cloud users to export metrics to Dynatrace for analysis, +and includes Redis-designed dashboards for use in monitoring Redis Cloud clusters. + +This integration makes it possible to: +- Collect and display metrics not available in the admin console +- Set up automatic alerts for node or cluster events +- Display these metrics alongside data from other systems + +{{< image filename="/images/rc/redis-cloud-dynatrace.png" >}} +## Install Redis' Dynatrace Integration for Redis Cloud + +The Dynatrace Integration is based on a feature of the Prometheus data source. Prometheus can forward metrics on to +another destination using remote writes. This will require a Prometheus installation inside the same datacenter as the +Redis Cloud deployment. + +If you have not already created a VPC between the Redis Cloud cluster and the network in which the machine hosting +Prometheus lives you should do so now. Please visit [VPC Peering](https://redis.io/docs/latest/operate/rc/security/vpc-peering/) +and follow the instructions for the cloud platform of your choice. + + + +## View metrics + +The Redis Cloud Integration for Dynatrace contains pre-defined dashboards to aid in monitoring your Redis Enterprise deployment. + +The following dashboards are currently available: + +- Cluster: top-level statistics indicating the general health of the cluster +- Database: performance metrics at the database level +- Shard: low-level details of an individual shard +- Active-Active: replication and performance for geo-replicated clusters +- Proxy: network and command information regarding the proxy +- Proxy Threads: processor usage information regarding the proxy's component threads + +## Monitor metrics + +Dynatrace dashboards can be filtered using the text area. For example, when viewing a cluster dashboard it is possible +filter the display to show data for only one cluster by typing 'cluster' in the text area and waiting for the system to +retrieve the relevant data before choosing one of the options in the 'cluster' section. + +Certain types of data do not know the name of the database from which they were drawn. The dashboard should have a list +of database names and ids; use the id value when filtering input to the dashboard. + + + diff --git a/content/integrate/dynatrace-with-redis-enterprise/_index.md b/content/integrate/dynatrace-with-redis-enterprise/_index.md new file mode 100644 index 0000000000..c348c3d66a --- /dev/null +++ b/content/integrate/dynatrace-with-redis-enterprise/_index.md @@ -0,0 +1,69 @@ +--- +LinkTitle: Dynatrace with Redis Enterprise +Title: Dynatrace with Redis Enterprise +alwaysopen: false +categories: +- docs +- integrate +- rs +description: To collect, view, and monitor metrics data from your databases and other + cluster components, you can connect Dynatrace to your Redis Enterprise cluster using + the Redis Dynatrace Integration. +group: observability +summary: To collect, view, and monitor metrics data from your databases and other + cluster components, you can connect Dynatrace to your Redis Enterprise cluster using + the Redis Dynatrace Integration. +type: integration +weight: 7 +--- + + +[Dynatrace](https://www.dynatrace.com/) is used by organizations of all sizes and across a wide range of industries to +enable digital transformation and cloud migration, drive collaboration among development, operations, security and +business teams, accelerate time to market for applications, reduce time to problem resolution, secure applications and +infrastructure, understand user behavior, and track key business metrics. + +The Dynatrace Integration for Redis Enterprise uses Prometheus remote write functionality to connect Prometheus data +sources to Dynatrace. This integration enables Redis Enterprise users to export metrics to Dynatrace for analysis, +and includes Redis-designed dashboards for use in monitoring Redis Enterprise clusters. + +This integration makes it possible to: +- Collect and display metrics not available in the admin console +- Set up automatic alerts for node or cluster events +- Display these metrics alongside data from other systems + +{{< image filename="/images/rs/redis-enterprise-dynatrace.png" >}} +## Install Redis' Dynatrace Integration for Redis Enterprise + +At the present time the Dynatrace integration is not signed by Dynatrace, meaning that it will be necessary to download +the source configuration and dashboards and assemble them and sign them cryptologically with a certificate that you have +created. The instructions for this procedure can be found on the Dynatrace +[site](https://docs.dynatrace.com/docs/extend-dynatrace/extensions20/sign-extension). Please note that the instructions +would have you place the dashboards next to the src folder; this is incorrect, the dashboards should be located inside +the src folder. + +## View metrics + +The Redis Enterprise Integration for Dynatrace contains pre-defined dashboards to aid in monitoring your Redis Enterprise deployment. + +The following dashboards are currently available: + +- Cluster: top-level statistics indicating the general health of the cluster +- Database: performance metrics at the database level +- Node: machine performance statistics +- Shard: low-level details of an individual shard +- Active-Active: replication and performance for geo-replicated clusters +- Proxy: network and command information regarding the proxy +- Proxy Threads: processor usage information regarding the proxy's component threads + + +## Monitor metrics + +Dynatrace dashboards can be filtered using the text area. For example, when viewing a cluster dashboard it is possible to +filter the display to show data for only one cluster by typing 'cluster' in the text area and waiting for the system to +retrieve the relevant data before choosing one of the options in the 'cluster' section. + +Certain types of data do not know the name of the database from which they were drawn. The dashboard should have a list +of database names and ids; use the id value when filtering input to the dashboard. + + diff --git a/content/integrate/new-relic-with-redis-cloud/_index.md b/content/integrate/new-relic-with-redis-cloud/_index.md new file mode 100644 index 0000000000..682266dffe --- /dev/null +++ b/content/integrate/new-relic-with-redis-cloud/_index.md @@ -0,0 +1,102 @@ +--- +LinkTitle: New Relic with Redis Cloud +Title: New Relic with Redis Cloud +alwaysopen: false +categories: +- docs +- integrate +- rs +description: To collect, view, and monitor metrics data from your databases and other + cluster components, you can connect New Relic to your Redis Cloud cluster using + the Redis New Relic Integration. +group: observability +summary: To collect, view, and monitor metrics data from your databases and other + cluster components, you can connect New Relic to your Redis Cloud cluster using + the Redis New Relic Integration. +type: integration +weight: 7 +--- + + +[New Relic](https://newrelic.com/?customer-bypass=true) is used by organizations of all sizes and across a wide range of industries to +enable digital transformation and cloud migration, drive collaboration among development, operations, security and +business teams, accelerate time to market for applications, reduce time to problem resolution, secure applications and +infrastructure, understand user behavior, and track key business metrics. + +The New Relic Integration for Redis Cloud uses Prometheus remote write functionality to connect Prometheus data +sources to New Relic. This integration enables Redis Cloud users to export metrics to New Relic for analysis, +and includes Redis-designed dashboards for use in monitoring Redis Cloud clusters. + +This integration makes it possible to: +- Collect and display metrics not available in the admin console +- Set up automatic alerts for node or cluster events +- Display these metrics alongside data from other systems + +{{< image filename="/images/rc/redis-cloud-newrelic.png" >}} +## Install Redis' New Relic Integration for Redis Cloud + +The New Relic Integration for Redis is based on a feature of the Prometheus data source. Prometheus can forward metrics on to +another destination using remote writes. This will require a Prometheus installation inside the same datacenter as the +Redis Cloud deployment. + +If you have not already created a VPC between the Redis Cloud cluster and the network in which the machine hosting +Prometheus lives you should do so now. Please visit [VPC Peering](https://redis.io/docs/latest/operate/rc/security/vpc-peering/) +and follow the instructions for the cloud platform of your choice. + +Finally, the Prometheus installation must be configured to pull metrics from Redis Cloud and write them to New Relic. There +are two sections, first the pull from Redis and second the write to New Relic. + +Get metrics from Redis Cloud: + +```yaml + - job_name: "redis-cloud" + scrape_interval: 30s + scrape_timeout: 30s + metrics_path: / + scheme: https + tls_config: + insecure_skip_verify: true + static_configs: + # The default Redis Cloud Prometheus port is 8070. + # Replace REDIS_CLOUD_HOST with your cluster's hostname. + - targets: ["REDIS_CLOUD_HOST:8070"] +``` + +Write them to New Relic: + +```yaml +# Remote write configuration for New Relic. +# - Replace REDIS_CLOUD_SERVICE NAME with any name you'd like to use to refer to this data source. +# - Replace NEW_RELIC_BEARER_TOKEN with the token you generated on the New Relic Administration -> API Keys page. +remote_write: +- url: https://metric-api.newrelic.com/prometheus/v1/write?prometheus_server=REDIS_CLOUD_SERVICE_NAME + authorization: + credentials: NEW_RELIC_BEARER_TOKEN +``` + +## View metrics + +The Redis Cloud Integration for New Relic contains pre-defined dashboards to aid in monitoring your Redis Enterprise deployment. + +The following dashboards are currently available: + +- Cluster: top-level statistics indicating the general health of the cluster +- Database: performance metrics at the database level +- Node +- Shard: low-level details of an individual shard +- Active-Active: replication and performance for geo-replicated clusters +- Proxy: network and command information regarding the proxy +- Proxy Threads: processor usage information regarding the proxy's component threads + +## Monitor metrics + +New Relic dashboards can be filtered using the text area. For example, when viewing a cluster dashboard it is possible to +filter the display to show data for only one cluster by typing 'cluster' in the text area and waiting for the system to +retrieve the relevant data before choosing one of the options in the 'cluster' section. + +Certain types of data do not know the name of the database from which they were drawn. The dashboard should have a list +of database names and ids; use the id value when filtering input to the dashboard. + + + + diff --git a/content/integrate/new-relic-with-redis-enterprise/_index.md b/content/integrate/new-relic-with-redis-enterprise/_index.md new file mode 100644 index 0000000000..2afdff69e9 --- /dev/null +++ b/content/integrate/new-relic-with-redis-enterprise/_index.md @@ -0,0 +1,93 @@ +--- +LinkTitle: New Relic with Redis Enterprise +Title: New Relic with Redis Enterprise +alwaysopen: false +categories: +- docs +- integrate +- rs +description: To collect, view, and monitor metrics data from your databases and other + cluster components, you can connect New Relic to your Redis Enterprise cluster using + the Redis New Relic Integration. +group: observability +summary: To collect, view, and monitor metrics data from your databases and other + cluster components, you can connect New Relic to your Redis Enterprise cluster using + the Redis New Relic Integration. +type: integration +weight: 7 +--- + + +[New Relic](https://newrelic.com/?customer-bypass=true) is used by organizations of all sizes and across a wide range of industries to +enable digital transformation and cloud migration, drive collaboration among development, operations, security and +business teams, accelerate time to market for applications, reduce time to problem resolution, secure applications and +infrastructure, understand user behavior, and track key business metrics. + +The New Relic Integration for Redis Enterprise uses Prometheus remote write functionality to connect Prometheus data +sources to New Relic. This integration enables Redis Enterprise users to export metrics to New Relic for analysis, +and includes Redis-designed dashboards for use in monitoring Redis Enterprise clusters. + +This integration makes it possible to: +- Collect and display metrics not available in the admin console +- Set up automatic alerts for node or cluster events +- Display these metrics alongside data from other systems + +{{< image filename="/images/rs/redis-enterprise-newrelic.png" >}} +## Install Redis' New Relic Integration for Redis Enterprise + +The New Relic Integration for Redis is based on a feature of the Prometheus data source. Prometheus can forward metrics on to +another destination using remote writes. The Prometheus installation must be configured to pull metrics from Redis +Enterprise and write them to New Relic. There are two sections, first the pull from Redis and second the write to New Relic. + +Get metrics from Redis Enterprise: + +```yaml + - job_name: "redis-enterprise" + scrape_interval: 30s + scrape_timeout: 30s + metrics_path: / + scheme: https + tls_config: + insecure_skip_verify: true + static_configs: + # The default Redis Enterprise Prometheus port is 8070. + # Replace REDIS_ENTERPRISE_HOST with your cluster's hostname. + - targets: ["REDIS_ENTERPRISE_HOST:8070"] +``` + +Write them to New Relic: + +```yaml +# Remote write configuration for New Relic. +# - Replace REDIS_ENTERPRISE_SERVICE NAME with any name you'd like to use to refer to this data source. +# - Replace NEW_RELIC_BEARER_TOKEN with the token you generated on the New Relic Administration -> API Keys page. +remote_write: +- url: https://metric-api.newrelic.com/prometheus/v1/write?prometheus_server=REDIS_ENTERPRISE_SERVICE_NAME + authorization: + credentials: NEW_RELIC_BEARER_TOKEN +``` + +## View metrics + +The Redis Enterprise Integration for New Relic contains pre-defined dashboards to aid in monitoring your Redis Enterprise deployment. + +The following dashboards are currently available: + +- Cluster: top-level statistics indicating the general health of the cluster +- Database: performance metrics at the database level +- Node +- Shard: low-level details of an individual shard +- Active-Active: replication and performance for geo-replicated clusters +- Proxy: network and command information regarding the proxy +- Proxy Threads: processor usage information regarding the proxy's component threads + +## Monitor metrics + +New Relic dashboards can be filtered using the text area. For example, when viewing a cluster dashboard it is possible to +filter the display to show data for only one cluster by typing 'cluster' in the text area and waiting for the system to +retrieve the relevant data before choosing one of the options in the 'cluster' section. + +Certain types of data do not know the name of the database from which they were drawn. The dashboard should have a list +of database names and ids; use the id value when filtering input to the dashboard. + + diff --git a/static/images/rc/redis-cloud-datadog.png b/static/images/rc/redis-cloud-datadog.png new file mode 100644 index 0000000000..6ffcf11717 Binary files /dev/null and b/static/images/rc/redis-cloud-datadog.png differ diff --git a/static/images/rc/redis-cloud-dynatrace.png b/static/images/rc/redis-cloud-dynatrace.png new file mode 100644 index 0000000000..9c1565f707 Binary files /dev/null and b/static/images/rc/redis-cloud-dynatrace.png differ diff --git a/static/images/rc/redis-cloud-newrelic.png b/static/images/rc/redis-cloud-newrelic.png new file mode 100644 index 0000000000..4996d19746 Binary files /dev/null and b/static/images/rc/redis-cloud-newrelic.png differ diff --git a/static/images/rs/redis-enterprise-datadog.png b/static/images/rs/redis-enterprise-datadog.png new file mode 100644 index 0000000000..5ff30b660f Binary files /dev/null and b/static/images/rs/redis-enterprise-datadog.png differ diff --git a/static/images/rs/redis-enterprise-dynatrace.png b/static/images/rs/redis-enterprise-dynatrace.png new file mode 100644 index 0000000000..9c1565f707 Binary files /dev/null and b/static/images/rs/redis-enterprise-dynatrace.png differ diff --git a/static/images/rs/redis-enterprise-newrelic.png b/static/images/rs/redis-enterprise-newrelic.png new file mode 100644 index 0000000000..b7bb1a4cca Binary files /dev/null and b/static/images/rs/redis-enterprise-newrelic.png differ