Skip to content

Latest commit

 

History

History
114 lines (52 loc) · 4.51 KB

logging.md

File metadata and controls

114 lines (52 loc) · 4.51 KB
copyright lastupdated keywords subcollection
years
2025
2025-04-22
logging
openpages

{{site.data.keyword.attribute-definition-list}}

Logging for {{site.data.keyword.openpages_short}}

{: #logging}

{{site.data.keyword.cloud_notm}} services, such as {{site.data.keyword.openpages_short}}, generate platform logs that you can use to investigate abnormal activity and critical actions in your account, and troubleshoot problems. {: shortdesc}

You can use {{site.data.keyword.logs_routing_full_notm}}, a platform service, to route platform logs in your account to a destination of your choice by configuring a tenant that defines where platform logs are sent. For more information, see About Logs Routing.

You can use {{site.data.keyword.logs_full_notm}} to visualize and alert on platform logs that are generated in your account and routed by {{site.data.keyword.logs_routing_full_notm}} to an {{site.data.keyword.logs_full_notm}} instance.

Locations where logs are sent by {{site.data.keyword.logs_routing_full_notm}}

{: #lr-locations}

The following table shows the {{site.data.keyword.openpages_short}} service instance regions that generate platform logs and the {{site.data.keyword.logs_routing_full_notm}} locations that they can send them to:

{{site.data.keyword.openpages_short}} service instance region {{site.data.keyword.logs_routing_full_notm}} location
AWS US East ( us-east-1 ) IBM Cloud Dallas ( us-south )
AWS Europe ( eu-central-1 ) IBM Cloud Frankfurt ( eu-de )
{: caption="{{site.data.keyword.openpages_short}} service instance regions and their corresponding {{site.data.keyword.logs_routing_full_notm}} locations" caption-side="bottom"}

Ensure that the instance is set to the same region as the region that users want to route logs to. For example, if the {{site.data.keyword.logs_routing_full_notm}} location is set to Dallas, then configure the To target instance to Dallas:

Logs routing set to Dallas target instance{: caption="Logs sent from Dallas location to Dallas target instance." caption-side="bottom"}

Platform logs that are generated

{: #log-platform}

{{site.data.keyword.openpages_short}} generates platform logs for the error, warning, and critical severity types.

Enabling logging

{: #log-enable}

Create {{site.data.keyword.logs_full_notm}} and configure routing by setting the target between source location to target instance.

Viewing logs

{: #log-viewing}

To view {{site.data.keyword.openpages_short}} logs, go to the Logging instance page{: external} and click the {{site.data.keyword.logs_full_notm}} instance.

Launching {{site.data.keyword.logs_full_notm}} from the Observability page

{: #log-launch-standalone}

For more information about launching the {{site.data.keyword.logs_full_notm}} UI, see Launching the UI in the {{site.data.keyword.logs_full_notm}} documentation.

Fields by log type

{: #log-fields}

For information about fields included in every platform log, see Fields that are included in platform logs.

{{site.data.keyword.openpages_short}} logs include the following fields:

Field Type Description
logSourceCRN Required Defines the account and flow log instance where the log is published.
saveServiceCopy Required Defines whether IBM saves a copy of the record for operational purposes.
message Required Description of the log that is generated.
messageID Required ID of the log that is generated.
{: caption="Log record fields" caption-side="bottom"}

{{site.data.keyword.openpages_short}} sends audit events as platform logs. For more information, see Auditing events for IBM OpenPages.

Analyzing {{site.data.keyword.openpages_short}} logs

{: #cloud-logs}

In the {{site.data.keyword.logs_full_notm}} dashboard, users can filter based on Application, Subsystem, and Severity to find logs specific to an instance. Users can also create a custom dashboard, view logs, or write a query to search for a log data.

They can also create alerts in the {{site.data.keyword.logs_full_notm}}.