From 9e26de29c82978d6341b9672720e343567e5d057 Mon Sep 17 00:00:00 2001 From: Dorota Wojcik Date: Thu, 21 Dec 2023 17:39:26 +0100 Subject: [PATCH] monitoring and logs part2 --- docs/integrations/datadog/add-custom-tags-to-datadog.rst | 3 +-- docs/integrations/datadog/datadog-logs.rst | 2 +- docs/integrations/datadog/datadog-metrics.rst | 4 ++-- docs/integrations/prometheus-system-metrics.rst | 2 +- docs/integrations/rsyslog.rst | 7 ++----- docs/integrations/rsyslog/loggly.rst | 2 +- docs/integrations/send-logs-to-elasticsearch.rst | 9 ++++----- .../howto/integrations/access-jmx-metrics-jolokia.rst | 7 +++---- docs/platform/howto/integrations/prometheus-metrics.rst | 2 +- 9 files changed, 16 insertions(+), 22 deletions(-) diff --git a/docs/integrations/datadog/add-custom-tags-to-datadog.rst b/docs/integrations/datadog/add-custom-tags-to-datadog.rst index ff7be0a117..6da9799b37 100644 --- a/docs/integrations/datadog/add-custom-tags-to-datadog.rst +++ b/docs/integrations/datadog/add-custom-tags-to-datadog.rst @@ -36,11 +36,10 @@ To add tags to the service integration: #. Log in to `Aiven Console `_, and select your service. -#. In the service **Overview** page, scroll to **Service integration** and select **Manage integrations**. +#. On the **Overview** page of your service, navigate to the **Service integrations** section and select **Manage integrations**. #. Next to the Datadog integration listed at the top on the Integrations screen, select **Edit** from the drop-down menu (ellipsis). #. Enter the desired tags in the provided field. You can add multiple tags by selecting the **Add** icon and optionally include descriptions for each tag. #. Select **Save configuration** to apply the changes. - diff --git a/docs/integrations/datadog/datadog-logs.rst b/docs/integrations/datadog/datadog-logs.rst index 3b2e3c1426..14ccd65c97 100644 --- a/docs/integrations/datadog/datadog-logs.rst +++ b/docs/integrations/datadog/datadog-logs.rst @@ -66,7 +66,7 @@ Send logs from an Aiven service to Datadog Follow the steps in this section for each of the services whose logs should be sent to Datadog. -1. From the **Service Overview** page, select **Manage integrations** and choose the **Rsyslog** option. +1. On the **Overview** page of your service, select **Integrations** from the sidebar, and select the **Rsyslog** option. .. image:: /images/integrations/rsyslog-service-integration.png :alt: Screenshot of system integrations including rsyslog diff --git a/docs/integrations/datadog/datadog-metrics.rst b/docs/integrations/datadog/datadog-metrics.rst index a52e2daf79..ddbd9be795 100644 --- a/docs/integrations/datadog/datadog-metrics.rst +++ b/docs/integrations/datadog/datadog-metrics.rst @@ -35,8 +35,8 @@ Add Datadog metrics integration to your Aiven service To enable the Datadog metrics integration for each service that requires metric tracking in Datadog, follow these steps: 1. In the `Aiven Console `_, select your service. -2. In the service **Overview** page, scroll to **Service integrations** and select **Manage integrations**. -3. In the **Integrations** screen, select **Datadog**. +2. From the **Overview** page of your service, scroll to **Service integrations** and select **Manage integrations**. +3. In the **Integrations** screen, select **Datadog Metrics**. 4. Select the Datadog endpoint you want to use from the drop-down list and select **Enable**. diff --git a/docs/integrations/prometheus-system-metrics.rst b/docs/integrations/prometheus-system-metrics.rst index 185c109275..5a8c62d38f 100644 --- a/docs/integrations/prometheus-system-metrics.rst +++ b/docs/integrations/prometheus-system-metrics.rst @@ -15,7 +15,7 @@ Get a list of available service metrics To discover the metrics available for your services, make an HTTP ``GET`` request to your Prometheus service endpoint. -1. Once your Prometheus integration is configured, collect the following Prometheus service details from `Aiven Console `_ > your service's the **Overview** page > the **Connection information** section > the **Prometheus** tab: +1. Once your Prometheus integration is configured, collect the following Prometheus service details from `Aiven Console `_ > the **Overview** page of your service > the **Connection information** section > the **Prometheus** tab: * Prometheus URL * Username diff --git a/docs/integrations/rsyslog.rst b/docs/integrations/rsyslog.rst index db96b2b7f8..3ace0e7b7d 100644 --- a/docs/integrations/rsyslog.rst +++ b/docs/integrations/rsyslog.rst @@ -83,13 +83,10 @@ Optional: Add rsyslog integration to service ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This can be configured in the Aiven Console by navigating to the target -service overview page and then scrolling down to the **Manage integrations** -button. - +This can be configured in the `Aiven Console `_ by navigating to the **Overview** page of the target service > the **Service integrations** section and selecting **Manage integrations**. You should be able to select your previously configured Rsyslog service -integration by clicking **Use integration** in the modal window. +integration by selecting **Enable** in the modal window. .. image:: /images/integrations/rsyslog-service-integration.png :alt: The page that shows the integrations available for a service diff --git a/docs/integrations/rsyslog/loggly.rst b/docs/integrations/rsyslog/loggly.rst index cd7c700d25..6a15b9afba 100644 --- a/docs/integrations/rsyslog/loggly.rst +++ b/docs/integrations/rsyslog/loggly.rst @@ -60,7 +60,7 @@ After enabling this service integration, it will be shown as active in the `Aive .. Note:: - It may take a few moments to setup the new log, and you can track the status in your service overview. + It may take a few moments to setup the new log, and you can track the status on the **Overview** page of your service > the **Service integrations** section. Your logs should now be visible on Loggly **Search** tab. Enter the tag name your previously specified (e.g. ``tag:your-tag`` ) and it will populate the dashboard with the log events from the Aiven service. diff --git a/docs/integrations/send-logs-to-elasticsearch.rst b/docs/integrations/send-logs-to-elasticsearch.rst index d9c656979e..6e76f24995 100644 --- a/docs/integrations/send-logs-to-elasticsearch.rst +++ b/docs/integrations/send-logs-to-elasticsearch.rst @@ -41,12 +41,11 @@ Send logs to an external service #. Navigate to **Services** from the menu on the left. #. Select the service which logs you want to send to the external Elasticsearch service. -#. On the service *Overview* page scroll to the section *Service integrations*. +#. On the **Overview** page of your service, navigate to the **Service integrations** section. #. Select **Manage integrations**. -#. Select Elasticsearch from the list. -#. In the newly appeared modal window choose the endpoint with name ``CONNECTION_NAME`` from the list and select **ENABLE**. -#. You can now close the modal window. -#. Observe the status change for newly added integration in the section **Service integrations** on the service overview page. +#. Select **Elasticsearch Logs** from the list. +#. In the newly-appeared modal window, select the endpoint with name ``CONNECTION_NAME`` from the list and select **ENABLE**. Close the modal window. +#. Observe the status change for newly-added integration in the **Service integrations** section on the **Overview** page of your service. #. Verify that the logs are flowing into your Elasticsearch. .. note:: Logs are split per day with index name consisting of your desired index prefix and a date in a format year-month-day, for example ``logs-2022-08-30``. diff --git a/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst b/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst index e8fb94107d..64ec737570 100644 --- a/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst +++ b/docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst @@ -29,12 +29,11 @@ Enabling Jolokia integration ------------------------------ To enable Jolokia integration for a specific service, follow these steps: -1. In the `Aiven console `_, open the service for which you want to enable Jolokia integration. -2. In the service **Overview** page, scroll to **Service integrations** and select **Manage integrations**. -3. In the **Integrations** page, select **Jolokia** from the list. +1. In the `Aiven Console `_, open the service for which you want to enable Jolokia integration. +2. On the **Overview** page of your service, navigate to the **Service integrations** section, and select **Manage integrations**. +3. On the **Integrations** page, select **Jolokia** from the list. 4. Select the Jolokia endpoint you created and select **Enable**. The system will configure the Jolokia endpoint on all service nodes, providing access to the metrics. - The Aiven Jolokia integration enables HTTP POST requests to retrieve values from service-specific metrics. It also supports bulk requests for batch collection of metrics. For more detailed information on the Jolokia protocol, refer to `Jolokia documentation `__ . diff --git a/docs/platform/howto/integrations/prometheus-metrics.rst b/docs/platform/howto/integrations/prometheus-metrics.rst index 23e940eec9..fd68a0799e 100644 --- a/docs/platform/howto/integrations/prometheus-metrics.rst +++ b/docs/platform/howto/integrations/prometheus-metrics.rst @@ -62,7 +62,7 @@ Aiven offers Prometheus endpoints for your services. To enable this feature, tak Accessing Prometheus in a VPC '''''''''''''''''''''''''''''' -If you use a VPC in your project, to access Prometheus, you need to go to `Aiven Console `_ > your project > the service you want to monitor using Prometheus > the **Overview** page > the **Advanced configuration** section and enable property ``public_access.prometheus``. +If you use a VPC in your project, to access Prometheus, you need to go to `Aiven Console `_ > your project > the service you want to monitor using Prometheus > the **Service settings** page > the **Cloud and network** section > the actions (**...**) menu > the **More network configurations**. In the **Network configuration** window, select **Add configuration options**, search for property ``public_access.prometheus``, enable it, and select **Save configuration**. Configure Prometheus --------------------