Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

Commit

Permalink
Updated platform monitoring content with the new console nav
Browse files Browse the repository at this point in the history
  • Loading branch information
harshini-rangaswamy committed Jul 11, 2023
1 parent 2494f99 commit 5d80d76
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 53 deletions.
54 changes: 26 additions & 28 deletions docs/platform/howto/integrations/access-jmx-metrics-jolokia.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,15 @@ Access JMX metrics via Jolokia

Only Aiven for Apache Kafka® has support for Jolokia integration.

Jolokia endpoint
----------------
Jolokia endpoint configuration
-------------------------------

To enable Jolokia integration for Aiven services, follow these steps to create a new Jolokia endpoint configuration:

1. Log in to the `Aiven console <https://console.aiven.io/>`_ , and from the **Services** page, select **Integration endpoints** on the left sidebar.
2. In the **Integrations** page, select **Jolokia**, and then select **Add new endpoint**.
3. Enter an **Endpoint name** for the new Jolokia endpoint and select **Create**. The system will automatically generate a username and password for authentication. In most cases, you can reuse the same Jolokia endpoint configuration for all services within a project.

To enable Jolokia integration for Aiven services you first need to
create a new Jolokia endpoint configuration. This can be created from
the **Integration endpoints** page. You only need to specify a display name
for the configuration and the system will automatically generate
username and password for authentication. In most cases, you can re-use
the same Jolokia endpoint configuration for all services within a
project.

.. image:: /images/integrations/jolokia-service-integration-image-1.png
:alt: Jolokia service integration endpoint
Expand All @@ -28,23 +27,21 @@ project.
.. note::
You can :ref:`create a new service endpoint using the Aiven CLI <avn_service_integration_endpoint_create>` as well.

Next, to enable Jolokia integration, you need to go to the
Service Overview page of each service you want to enable the integration
for. Click the **Set up integration** button under *Service integrations*
and then click **Use integration** under Jolokia from the popup. After finishing the wizard the
system will configure the endpoint on all nodes of the service that provide access to the metrics.
Enabling Jolokia integration
------------------------------
To enable Jolokia integration for a specific service, follow these steps:

1. In the `Aiven console <https://console.aiven.io/>`_, 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.
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.

Aiven Jolokia integration is configured to allow HTTP POST request to
read values from the service specific metrics. Bulk requests are
supported for batch collection as well. For further information on the
protocol, can refer to `Jolokia

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 <https://jolokia.org/reference/html/protocol.html>`__ .

Please do note that many of the metrics are specific to a Kafka® broker,
so you may need to query each individual node for the full picture. Node
IP is represented by a single DNS name. In a command line you can use
``host`` command (Unix systems) or ``nslookup`` command (Windows systems)
to get the list of IP addresses associated with a DNS name:
Several metrics are specific to a Kafka® broker. Therefore, you may need to query each node to obtain a comprehensive overview. The node IP is represented by a single DNS name. You can use the ``host`` command on Unix systems or the ``nslookup`` command on Windows systems to retrieve the list of IP addresses associated with a DNS name.


.. code-block:: shell
Expand All @@ -53,12 +50,13 @@ to get the list of IP addresses associated with a DNS name:
kafka-67bd7c5-myproject.aivencloud.com has address 35.228.234.106
kafka-67bd7c5-myproject.aivencloud.com has address 35.228.157.197
Here's a quick example of a cURL request. :doc:`Download the CA certificate </docs/platform/howto/download-ca-cert>` first before executing the cURL request.
The file is identical for all endpoints and services in the same project.
Please note to use port 6733 which is the default port Jolokia is
listening on. ``joljkr2l:PWD`` are the values of the username/password from the Jolokia endpoint setup step.
You can find these endpoint details on the **Integration endpoints** page.
Example cURL requests
-----------------------
Here is an example of a cURL request for accessing JMX metrics using Jolokia. Before executing the cURL request,:doc:`download the CA certificate </docs/platform/howto/download-ca-cert>` specific to your project. The CA certificate file is identical for all endpoints and services within the same project.
Performing a cURL request to read a specific metric:

Ensure that you use port 6733, the default port for Jolokia. Replace ``joljkr2l:PWD`` with the username and password obtained during the Jolokia endpoint setup step. You can find these endpoint details on the **Integration endpoints** page.

.. code-block:: shell
Expand Down
31 changes: 12 additions & 19 deletions docs/platform/howto/integrations/prometheus-metrics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,39 +18,32 @@ Enable Prometheus support on your Aiven project
Aiven offers Prometheus endpoints for your services. To enable this feature,
follow the steps below:

#. | Navigate to the project **Integration endpoints** page.

#. | Add a ``Prometheus`` integration endpoint if one does not already
exist.
#. | In the `Aiven console <https://console.aiven.io/>`_, select Projects at the top and select your project.
#. | Select **Integration endpoints** from the left sidebar.

#. | Select **Prometheus** from the list available integration endpoints
#. | Select **Add new endpoint** and enter the details for the endpoint. Select **Create**.

| Usually you only need one of these per project (as it can be used
for all services in the same project) so if you can see one has
already been created then you can skip this step.
#. | Navigate to your service that you
would like to monitor and click ``Manage integrations``

#. | Choose the ``Prometheus`` service integration by clicking
``Use integration``
#. | Next, navigate to the service that you would like to monitor and select **Manage integrations** from the service overview page.

#. | Confirm you have selected the Prometheus endpoint configured
earlier in step 2 and click ``Enable``
#. | In the **Integrations** screen, select **Prometheus**.
#. | Select the endpoint name you created from the drop-down list and select **Enable**. At the top of the **Integrations** page, you will see the Prometheus integration listed and the status ``Active``.

.. image:: /images/platform/integrations/prometheus-endpoint-select.png
:alt: Dialog box to select already configured Prometheus endpoints

#. | Check the service overview page to see that the integration has
been successfully enabled and is now ``Active``

#. | Copy the Prometheus connection information found from the top of
the service overview page under the new ``Prometheus`` tab
#. | Select **Overview** from the left sidebar, and then select **Prometheus** tab within the **Connection information** section.

#. | Copy the **Service URI** for the Prometheus connection information to log in to the browser and access the Prometheus dashboard.

.. image:: /images/platform/integrations/prometheus-service-info.png
:alt: Screenshot of Prometheus connection information in service overview page

At this point, the system will start an HTTP server on all nodes of the service
that provide access to the metrics. Note that there can be roughly one minute
delay until the metrics are available.
Once configured, the system will initiate an HTTP server on all service nodes, granting access to the metrics. It is important to note that there might be a slight delay of approximately one minute before the metrics become available.

Accessing Prometheus in a VPC
''''''''''''''''''''''''''''''
Expand Down
13 changes: 7 additions & 6 deletions docs/platform/howto/monitoring-services.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@ Monitoring services

When running Aiven services, you get access by default to both metrics and logs to monitor the health of your service from the `Aiven console <https://console.aiven.io/>`_.

1. Go to your **Services**, and open the service you want to review.
2. Metrics can be reviewed under the **Metrics** tab, with the choice of spanning the last hour, day, week, month or year.
3. Logs can be reviewed under the **Logs** tab. Older logs are loaded progressively. To come back to the most recent log entry, click on **Got to most recent message**
1. From the left sidebar, navigate to **Services** and select the service you want to review.
2. To review metrics, select **Metrics** from the left sidebar. You can select a time range spanning the last hour, day, week, month, or year.
3. For log analysis, select **Logs** from the left sidebar. Older logs will load progressively. To return to the most recent log entry, select **Go to most recent message**.


You can also use the dedicated functions :ref:`service logs <avn-service-logs>` and :ref:`service metrics <avn-service-metrics>` to export your service's monitoring data via the :doc:`Aiven CLI </docs/tools/cli>`.

Note that it is also possible to :doc:`export logs and metrics to an Aiven service or external provider</docs/platform/concepts/logs-metrics-alerts>`. For instance:
Additionaly, you have the option to :doc:`export logs and metrics to an Aiven service or external provider</docs/platform/concepts/logs-metrics-alerts>`, expanding your monitoring capabilities. For example:

- Sending logs to :doc:`Aiven for Opensearch</docs/products/opensearch>`.
- Sending metrics to :doc:`Aiven for m3</docs/products/m3db>`, and visualise these metrics with :doc:`Aiven for Grafana</docs/products/grafana>`.
- You can send logs to :doc:`Aiven for Opensearch</docs/products/opensearch>`.
- You can send metrics to :doc:`Aiven for m3</docs/products/m3db>`, and visualise these metrics with :doc:`Aiven for Grafana</docs/products/grafana>`.


Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/platform/integrations/prometheus-endpoint-select.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/platform/integrations/prometheus-service-info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5d80d76

Please sign in to comment.