Logging for Event Notifications
IBM Cloud® services, such as Event Notifications, generate platform logs that you can use to investigate abnormal activity and critical actions in your account, and troubleshoot problems.
You can use IBM Cloud Logs Routing, 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 IBM Cloud Logs to visualize and alert on platform logs that are generated in your account and routed by IBM Cloud Logs Routing to an IBM Cloud Logs instance.
As of 28 March 2024, the IBM Log Analysis service is deprecated and will no longer be supported as of 30 March 2025. Customers will need to migrate to IBM Cloud Logs before 30 March 2025. During the migration period, customers can use IBM Log Analysis along with IBM Cloud Logs. Logging is the same for both services. For information about migrating from IBM Log Analysis to IBM Cloud Logs and running the services in parallel, see migration planning.
Locations where platform logs are generated
Region | Supported |
---|---|
Dallas (us-south ) |
Yes |
Sydney (au-syd ) |
Yes |
Frankfurt (eu-de ) |
Yes |
Madrid (eu-es ) |
Yes |
London (eu-gb ) |
Yes |
Toronto (ca-tor ) |
Yes |
Tokyo (jp-tok ) |
Yes |
Osaka (jp-osa ) |
Yes |
Locations where logs are sent to IBM Log Analysis
Event Notifications sends platform logs to IBM Log Analysis in the regions indicated in the following table.
Dallas (us-south ) |
Washington (us-east ) |
Toronto (ca-tor ) |
Sao Paulo (br-sao ) |
---|---|---|---|
Yes | No | Yes | No |
Tokyo (jp-tok ) |
Sydney (au-syd ) |
Osaka (jp-osa ) |
Chennai (in-che ) |
---|---|---|---|
Yes | Yes | Yes | No |
Frankfurt (eu-de ) |
London (eu-gb ) |
Madrid (eu-es ) |
---|---|---|
Yes | Yes | Yes |
Locations where logs are sent to IBM Cloud Logs
Event Notifications sends platform logs to IBM Cloud Logs in the regions indicated in the following table.
Dallas (us-south ) |
Washington (us-east ) |
Toronto (ca-tor ) |
Sao Paulo (br-sao ) |
---|---|---|---|
Yes | No | Yes | No |
Tokyo (jp-tok ) |
Sydney (au-syd ) |
Osaka (jp-osa ) |
Chennai (in-che ) |
---|---|---|---|
Yes | Yes | Yes | No |
Frankfurt (eu-de ) |
London (eu-gb ) |
Madrid (eu-es ) |
---|---|---|
Yes | Yes | Yes |
Locations where logs are sent by IBM Cloud Logs Routing
Event Notifications sends logs by IBM Cloud Logs Routing in the regions that are indicated in the following table.
Dallas (us-south ) |
Washington (us-east ) |
Toronto (ca-tor ) |
Sao Paulo (br-sao ) |
---|---|---|---|
Yes | No | Yes | No |
Tokyo (jp-tok ) |
Sydney (au-syd ) |
Osaka (jp-osa ) |
Chennai (in-che ) |
---|---|---|---|
Yes | Yes | Yes | No |
Frankfurt (eu-de ) |
London (eu-gb ) |
Madrid (eu-es ) |
---|---|---|
Yes | Yes | Yes |
Enabling logging
Platform logs are logs that are exposed by logging-enabled services and the platform in IBM Cloud. You can configure IBM Cloud logs instance to receive the logs sent by service. See IBM Cloud Logs for more information.
Viewing logs
To view and analyze platform logs for an Event Notifications instance, check that the IBM Cloud Logs Routing instance is provisioned and target is set for the same region where the Event Notifications instance that you want to monitor is available.
To start the IBM Cloud Logs Routing web UI to view logs, see Navigating to the web UI.
Launching IBM Cloud Logs from the Observability page
For more information about launching the IBM Cloud Logs UI, see Launching the UI in the IBM Cloud Logs documentation.
Fields per log type
See the following table for the list of fields that are included in each log record:
Field | Type | Description |
---|---|---|
logSourceCRN |
Required | Defines the account where the log is published. |
saveServiceCopy |
Required | Defines whether IBM saves a copy of the record for operational purposes. |
resourceGroupId |
Required | Defines the resource group that is associated with the Event Notifications instance. |
message |
Required | Description of the log that is generated. |
msg_timestamp |
Required | UTC timestamp of the message. |
messageID |
Required | ID of the log that is generated. |
resolution |
Optional | Guidance on how to proceed if you receive this log record. |
documentsURL |
Optional | More information on how to proceed if you receive this log record. |
sourceID |
Required | CRN of the IBM Cloud service that sends the notification through the Event Notifications service. |
notificationID |
Optional | ID of the notification that is sent to a destination. |
destinationID |
Optional | ID of the destination for which the status is being reported. |
level |
Required | Type of log. Valid values are INFO , WARN , ERROR |
For information about fields included in every platform log, see Fields for platform logs.
Log messages
The following table lists the message IDs that are generated by Event Notifications:
Message ID | Log type | Description |
---|---|---|
event-notifications.00001I |
INFO |
This message provides information that a notification event from a source has been received.CRN is used for IBM Cloud services. SourceID can be an IBM Cloud service or a human, for example |
event-notifications.00002I |
INFO |
This message provides information that a notification ID has been assigned to the event that originated from a source. |
event-notifications.00003I |
INFO |
This message provides information that a notification event is published through a list of topic IDs. |
event-notifications.00004I |
INFO |
This message provides information that a notification request is process by a list of subscribers. |
event-notifications.00006I |
INFO |
This message provides information about the devices available for a valid platform. Valid platforms are [push_chrome, push_firefox, push_android, push_ios, push_safari] |
event-notifications.00007I |
INFO |
This message provides information that an SMS is dispatched to a list of telephone numbers. |
event-notifications.00008I |
INFO |
This message provides information that an email is sent to a specified list of addresses. |
event-notifications.00009I |
INFO |
This message provides information that the webhook has been successfully served and reflects the response with the status code as 200 from the webhook API. |
event-notifications.00010I |
INFO |
This message provides information that a notification event is sent to a specified list of subscriptions. |
event-notifications.00011I |
INFO |
This message provides information that a notification event is sent to a specified list of destinations. |
event-notifications.00012I |
INFO |
This message provides information about the number of devices and platforms for which a notification has been processed successfully. |
event-notifications.00013I |
INFO |
This message provides information about the number of devices and platforms for which a notification has been dispatched successfully. |
event-notifications.00014I |
INFO |
This message provides information that the slack destination has been successfully served and reflects the response with the status code as 200 from the slack API. |
event-notifications.00015I |
INFO |
This message provides information that a notification is delivered to a device on a platform with a corresponding destination ,device and platform ID. |
event-notifications.00015I |
INFO |
This message provides information about the device,platform and destination ID where the user has opened the notification. |
event-notifications.00016I |
INFO |
This message provides information that the Microsoft Teams destination has been succesfully served and reflects the response with the status code as 200 from the Microsoft Teams API. |
event-notifications.00018I |
INFO |
This message provides information that the Pager Duty destination has been succesfully served and reflects the response with the status code as 200 from the Pager Duty API. |
event-notifications.00019I |
INFO |
This message provides information that the Code Engine destination has been successfully served and reflects the response with the status code as 200 from the Code Engine API. |
event-notifications.00020I |
INFO |
This message provides information that a notification has been succesfully served to the Service Now destination has been served and reflects the response with the status code as 200 from the Service Now API. |
event-notifications.00021I |
INFO |
This message provides information that the IBM Cloud Object Storage has been succesfully served and reflects the response from the IBM Cloud Object Storage API. |
event-notifications.00022I |
INFO |
This message provides information about an email of a specific size has been sent to a specified list of recipients from the sender. |
event-notifications.00023I |
INFO |
This message provides information about an email of a specific size has been deferred to a specified list of recipients from the sender. |
event-notifications.00001W |
WARN |
This message provides a warning that a notification event from a source has been rejected because no topic is configured for the source. The topic that is required to filter the event is missing. |
event-notifications.00002W |
WARN |
This message provides a warning that a notification event from a source is invalid as it is not filtered by any topic. |
event-notifications.00003W |
WARN |
This message provides a warning that a notification request processed by a specified list of subscribers is forbidden for a destination type. |
event-notifications.00004W |
WARN |
This message provides a warning that a notification has not been dispatched as it has no subscribers. |
event-notifications.00005W |
WARN |
This message provides a warning that the webhook API has returned an erroneous response with the status code 404. |
event-notifications.00006W |
WARN |
This message provides a warning that the slack API has returned an erroneous response with the status code 404. |
event-notifications.00007W |
WARN |
This message provides a warning that the Microsoft Teams API has returned an erroneous response with the status code 401. |
event-notifications.00008W |
WARN |
This message provides a warning that the SMS is not delivered because it is unsubscribed by the SMS numbers. |
event-notifications.00010W |
WARN |
This message provides a warning that the Pager Duty API has returned an erroneous response with the status code 401. |
event-notifications.00011W |
WARN |
This message provides a warning that the Code Engine API has returned an erroneous response with the status code 401. |
event-notifications.00012W |
WARN |
This message provides a warning that the Service Now API has returned an erroneous response with the status code 401. |
event-notifications.00013W |
WARN |
This message provides a warning that an email of a specific size has bounced and the authenticity of the email has to be checked. |
event-notifications.00001E |
ERROR |
This error message indicates that the notifications failed to dispatch to invalid devices. |
event-notifications.00002E |
ERROR |
This error message indicates that the webhook API returned an erroneous response with the status code 404. |
event-notifications.00003E |
ERROR |
This error message indicates that the notifications failed to dispatch due to authentication error for device and platform . |
event-notifications.00004E |
ERROR |
This error message indicates that the Slack API returned an erroneous response with the status code 401. |
event-notifications.00005E |
ERROR |
This error message indicates that the notifications failed to dispatch due to the BadDeviceToken error for a device and platform. |
event-notifications.00006E |
ERROR |
This error message indicates that the Microsoft Teams API returned an erroneous response with the status code 401. |
event-notifications.00008E |
ERROR |
This error message indicates that the Pager Duty API returned an erroneous response with the status code 401. |
event-notifications.00009E |
ERROR |
This error message indicates that the Code Engine API returned an erroneous response with the status code 401. |
event-notifications.00010E |
ERROR |
This error message indicates that the Service Now API returned an erroneous response with the status code 401. |
List logs generated by a service
If you want to view all the logs that are being generated for a particular instance, select the guid
of Event Notifications instance from left panel under subsystems and search the source in serach bar.
List logs for a notification request
If you know the notification ID that is generated for a request from a service or source to the Event Notifications service, use the following query in IBM Cloud Logs to list all logs for that particular notification ID:
<notification Id>