For AI agents: the complete documentation index is available at https://docs.us.ovhcloud.com/en/llms.txt, the full documentation bundle is available at https://docs.us.ovhcloud.com/en/llms-full.txt, and this page is available as Markdown at https://docs.us.ovhcloud.com/en/manage-and-operate/kms/key-management-service-pushing-logs-to-logs-data-platform.md.
  • English

Key Management Service - Pushing logs to Logs Data Platform

View as Markdown

Requirements

 

Instructions

Description

OVHcloud KMS has a native integration with Logs Data Platform for logs management.

 

Logs direct access

From the OVHcloud Control Panel, navigate to your Key Management Service via the Identity, Security & Operations menu.

Once there, click the Logs tab.

Manager tab - Key management service pushing logs logs data platform

This tab displays all KMS logs in real time. A selector allows you to switch the display between the two types of logs:

  • REST API audit logs.
  • KMIP audit logs.

 

Logs access through LDP

From the Logs tab, you can Subscribe to an LDP data stream. Once the subscription is enabled, all the logs will be pushed to Logs Data Platform to archive generated logs and perform advanced searches, and create alerts or visualizations.

For more information, please refer to our Quick Start for Logs Data Platform guide.

Manager - Key management service pushing logs logs data platform

 

Available logs details

KMS logs contain the following information:

  • REST API

    Logs are displayed with this format:

    {{ http_method }} {{ http_path }} - {{ http_status }} - identity: {{ iam_identities }} - operation: {{ iam_operation }} on {{ res_urn }} - from {{ip}} with certificate {{cert_id}} - request id: {{ request_id }}

    Example:

    INFO | GET /v1/servicekey/77f0a3f6-c2ef-4e76-xxxx-xxxxxxxxxxxx - 200 - identity: urn:v1:us:identity:group:xx1111-ovh/john.smith - operation: okms:apiovh:serviceKey/get on urn:v1:us:resource:okms:8d1c84cc-1128-4629-xxxx-xxxxxxxxxx/serviceKey/77f0a3f6-c2ef-4e76-xxxx-xxxxxxxxxxxx - from Manager/APIv2 - request id: us.manager-5.684c3abe.3880620.2080cff16eaa5539bf92cxxxxxxxx

    Elements that can be pushed to Logs Data Platform:

    FieldDescription
    domain_idOKMS domain ID
    request_idrequest ID
    type 
    log_levelLog priority level
    client_ipIP of the client making the request
    tls_cert_idAuthentication certificate ID used
    res_urntarget resource URN
    regionOKMS domain region
    iam_operationIAM action evalutated
    iam_identitiesIAM identity used for rights evaluation
    http_pathRequest path
    http_statusHTTP answer status
    http_methodRequest method
    err_categoryError category

  • KMIP

    Logs are displayed with this format:

    {{ http_method }} {{ http_path }} - {{ http_status }} - identity: {{ iam_identities }} - operation: {{ iam_operation }} on {{ res_urn }} - from {{ip}} with certificate {{cert_id}} - request id: {{ request_id }}

    Example:

    INFO | GET on urn:v1:us:resource:okms:8d1c84cc-1128-4629-xxxx-xxxxxxxxxxx/kmip/ff55638c-3e86-4cb3-xxxx-xxxxxxxx - identity: urn:v1:us:identity:account:xx1111-ovh - operation: okms:kmip:get - from XXX.XXX.XXX.XXX with certificate e7850a19-a5de-4527-xxxx-xxxxxxxxx - request id: OKMS.db61c455-abfa-4a66-xxxx-xxxxxxxxxxx

    Elements that can be pushed to Logs Data Platform:

    FieldDescription
    domain_idOKMS domain ID
    request_idRequest ID
    log_levelLog priority level
    client_ipIP of the client making the request
    tls_cert_idAuthentication certificate ID used
    res_urnTarget resource URN
    regionOKMS domain region
    iam_operationIAM action evalutated
    iam_identitiesIAM identity used for rights evaluation
    kmip_operationKMIP operation used
    kmip_reasonStandard KMIP error code

 

Go further

Browse all the Key Management Service (KMS) guides.

Browse the rest of the OVHcloud US documentation for guides on our other products and services.

Learn more about Key Management Service on the OVHcloud US website.