1
0
mirror of https://github.com/minio/docs.git synced 2025-07-28 19:42:10 +03:00

Migration: Metrics and Logging

Apply suggestions from code review via Eco

Co-authored-by: Eco <41090896+eco-minio@users.noreply.github.com>

Completing response to eco PR

Minor fixup

One more fixup
This commit is contained in:
ravindk89
2021-05-26 19:31:37 -04:00
committed by Ravind Kumar
parent d330b2dc29
commit 9b4ec43824
11 changed files with 1561 additions and 190 deletions

View File

@ -35,17 +35,22 @@ legacy documentation site
Syntax
------
:mc-cmd:`mc admin prometheus` has the following syntax:
.. mc-cmd:: generate
:fullpath:
.. code-block:: shell
:class: copyable
Generates a JWT bearer token for use with configuring
:ref:`Prometheus metrics collection <minio-metrics-and-alerts>`. The command
has the following syntax:
mc admin prometheus generate TARGET
.. code-block:: shell
:class: copyable
:mc-cmd:`mc admin prometheus` supports the following:
mc admin prometheus generate TARGET
.. mc-cmd:: TARGET
The command accepts the following arguments:
The :mc:`alias <mc alias>` of a configured MinIO deployment for which
the command generates a Prometheus-compatible configuration file.
.. mc-cmd:: TARGET
The :mc:`alias <mc alias>` of a configured MinIO deployment for which
the command generates a Prometheus-compatible configuration file.

View File

@ -1,4 +1,4 @@
===================
m===================
``mc admin config``
===================
@ -53,6 +53,144 @@ Configuration Settings
The following configuration settings define runtime behavior of the
MinIO :mc:`server <minio server>` process:
.. _minio-server-config-logging-logs:
HTTP Webhook Log Target
~~~~~~~~~~~~~~~~~~~~~~~
.. mc-conf:: logger_webhook
The top-level configuration key for defining an HTTP webhook target for
publishing :ref:`MinIO logs <minio-logging>`.
Use :mc-cmd:`mc admin config set` to set or update an HTTP webhook target.
Specify additional optional arguments as a whitespace (``" "``)-delimited
list.
.. code-block:: shell
:class: copyable
mc admin config set logger_webhook \
endpoint="http://webhook.example.net" [ARGUMENTS=VALUE ...]
You can specify multiple HTTP webhook targets by appending
``[:name]`` to the top-level key. For example, the following commands
set two distinct HTTP webhook targets as ``primary`` and ``secondary``
respectively:
.. code-block:: shell
:class: copyable
mc admin config set logger_webhook:primary \
endpoint="http://webhook-01.example.net" [ARGUMENTS=VALUE ...]
mc admin config set logger_webhook:secondary \
endpoint="http://webhook-02.example.net" [ARGUMENTS=VALUE ...]
The :mc-conf:`logger_webhook` configuration key accepts the following
arguments:
.. mc-conf:: endpoint
*Required*
The HTTP endpoint of the webhook.
This setting corresponds to the
:envvar:`MINIO_LOGGER_WEBHOOK_ENDPOINT` environment variable.
.. mc-conf:: auth_token
*Optional*
The JSON Web Token (JWT) to use for authenticating to the HTTP webhook.
Omit for webhooks which do not enforce authentication.
This setting corresponds to the
:envvar:`MINIO_LOGGER_WEBHOOK_AUTH_TOKEN` environment variable.
.. _minio-server-config-logging-audit:
HTTP Webhook Audit Log Target
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. mc-conf:: audit_webhook
The top-level configuration key for defining an HTTP webhook target for
publishing :ref:`MinIO audit logs <minio-logging>`.
Use :mc-cmd:`mc admin config set` to set or update an HTTP webhook target.
Specify additional optional arguments as a whitespace (``" "``)-delimited
list.
.. code-block:: shell
:class: copyable
mc admin config set audit_webhook \
endpoint="http://webhook.example.net" [ARGUMENTS=VALUE ...]
You can specify multiple HTTP webhook targets by appending
``[:name]`` to the top-level key. For example, the following commands
set two distinct HTTP webhook targets as ``primary`` and ``secondary``
respectively:
.. code-block:: shell
:class: copyable
mc admin config set audit_webhook:primary \
endpoint="http://webhook-01.example.net" [ARGUMENTS=VALUE ...]
mc admin config set audit_webhook:secondary \
endpoint="http://webhook-02.example.net" [ARGUMENTS=VALUE ...]
The :mc-conf:`audit_webhook` configuration key accepts the following
arguments:
.. mc-conf:: endpoint
*Required*
The HTTP endpoint of the webhook.
This setting corresponds to the
:envvar:`MINIO_AUDIT_WEBHOOK_ENDPOINT` environment variable.
.. mc-conf:: auth_token
*Optional*
The JSON Web Token (JWT) to use for authenticating to the HTTP webhook.
Omit for webhooks which do not enforce authentication.
This setting corresponds to the
:envvar:`MINIO_AUDIT_WEBHOOK_AUTH_TOKEN` environment variable.
.. mc-conf:: client_cert
*Optional*
The x.509 client certificate to present to the HTTP webhook. Omit for
webhooks which do not require clients to present a known TLS certificate.
Requires specifying :mc-conf:`~audit_webhook.client_key`.
This setting corresponds to the
:envvar:`MINIO_AUDIT_WEBHOOK_CLIENT_CERT` environment variable.
.. mc-conf:: client_key
*Optional*
The x.509 private key to present to the HTTP webhook. Omit for
webhooks which do not require clients to present a known TLS certificate.
Requires specifying :mc-conf:`~audit_webhook.client_cert`.
This setting corresponds to the
:envvar:`MINIO_AUDIT_WEBHOOK_CLIENT_KEY` environment variable.
.. _minio-server-config-bucket-notification-amqp:
AMQP Service for Bucket Notifications