GCP PubSub integration configuration fields
Summarize
Summary of GCP PubSub integration configuration fields
This document describes the configuration fields required to set up the GCP PubSub integration for Health Log Analytics in ServiceNow. It guides customers on how to connect and stream log data from Google Cloud Pub/Sub to their ServiceNow instance, ensuring proper ingestion and processing of logs.
Show less
Key Configuration Fields
- Integration Name: A unique required name to identify the integration, which customizes the generic form label accordingly.
- Service Instance: Required field specifying the ServiceNow service instance bound to the incoming log data.
- Execute on: Option to select either a specific MID Server or a MID Server cluster for log ingestion, supported from Health Log Analytics version 26.0.17 onward.
- MID Server name: When using a specific MID Server, select one that supports basic authentication and has log ingestion enabled (this can be auto-enabled by Health Log Analytics). Maximum of 10 concurrent data inputs per MID Server by default.
- MID Server cluster: When using a cluster, it must be a failover cluster containing MID Servers with basic authentication and log ingestion enabled. Health Log Analytics automatically enables ingestion if needed. Clusters must have capacity validation based on active MID Server load.
- Source: Read-only field indicating the log data source as PubSub.
- Description: Optional brief text to help identify the integration.
Connection Setup Fields
- Project ID: Required Google Cloud project identifier, obtainable from the Google Cloud homepage.
- Authentication method: Required credential alias used for Google Cloud access, defaulting to snocc.HLACredentialAlias. Additional aliases can be managed and added.
- Topic name: Required Google Cloud Pub/Sub topic to subscribe to, found via the Google Cloud console.
- Subscription name: Optional name for the subscription that Health Log Analytics uses to receive logs; defaults to ServiceNow-Subscription if left blank.
Advanced Settings
- Subscriber thread pool size: Number of concurrent threads for downloading logs; default is 1.
- Sub sample receive ratio: Controls log sampling by specifying how many logs to group before receiving one (default -1 means receive all logs). Example: setting to 5 receives one log out of every five.
- Max length in bytes: Maximum size of individual log messages; default is 32,766 bytes.
- Character encoding: Read-only field fixed to UTF-8.
- Sub sample drop ratio: Controls log dropping by specifying how many logs to group before dropping one (default -1 means no logs discarded). Example: setting to 5 drops one log out of every five.
- Rate limit: Maximum events processed per second; default is -1 for unlimited.
- Default timezone: Time zone used when logs do not specify one; default is GMT.
- Drop if queue is full: Option to discard logs when the processing queue is overloaded.
Practical Implications
By correctly configuring these fields, ServiceNow customers can efficiently stream and manage Google Cloud Pub/Sub log data in Health Log Analytics. The integration supports failover MID Server clusters for reliability and provides sampling and rate-limiting controls to optimize log ingestion volume. Authentication and project/topic details ensure secure and targeted data collection. This setup improves visibility into cloud logs within ServiceNow for enhanced operational insights.
Description of the fields on the GCP PubSub integration configuration forms for Health Log Analytics.
| Field | Description |
|---|---|
| Integration Name | Unique name of this integration. For example: My GCP PubSub integration. This field is required. Note: When you fill in this field, the generic name displayed on the form adjusts automatically to match the name you
entered. |
| Service Instance | The service instance (formerly the application service) to which to bind the log data. This field is required. |
| Execute on | Option to determine whether to use a specific MID Server or a MID Server cluster. This feature is supported in the Health Log Analytics application, Version 26.0.17 - February 2023 and later, available from the ServiceNow Store. |
| MID Server name |
(Only when Execute on is set to Specific MID Server.) The MID Server to which the logs are streamed.Note: This field is required.
|
| MID Server cluster | (Only when the Execute on field is set to Specific MID Server Cluster) The MID Server cluster to which the log data is pulled.The data input runs on a single MID Server in the cluster until that MID Server fails. The system then moves all the data input tasks to the next available MID Server in the cluster according to the configured order. This feature is supported in the Health Log Analytics application, Version 26.0.17 - February 2023 and later, available from the ServiceNow Store. Note: For more information about MID Server clusters, see Configure a MID Server cluster.
This field is required. |
| Source | The source of the log data that the integration pulls to your ServiceNow instance: PubSub. This field is read-only. |
| Description | Option to add a brief description of the integration to help identify it. |
| Field | Description |
|---|---|
| Project ID | The project ID of the Google Cloud project. For example, my-project-id. This field is required. You can obtain the project ID from your Google Cloud homepage by selecting My Project. The project ID will be displayed. |
| Authentication method | The credential alias ServiceNow® uses to access Google Cloud. The default value is sn_occ.HLA_Credential_Alias. This field is required Note:
You can add more credential aliases to the list of available aliases to choose from by selecting Manage credential aliases from the list and adding a credential alias. |
| Topic name | The Google Cloud Pub/Sub topic to which to subscribe Health Log Analytics. For example, my_topic. This field is required. You can obtain the topic name from your Google Cloud homepage by searching for Pub/Sub. All topic names will be displayed. |
| Subscription name | The subscription Health Log Analytics uses to receive log data that is published on the Google Cloud Pub/Sub topic. If you leave this field blank, Health Log Analytics uses ServiceNow-Subscription. |
| Field | Description | Default value |
|---|---|---|
| Subscriber thread pool size | The number of concurrent threads that are downloading files from the Google Cloud Pub/Sub topic. | 1 |
| Sub sample receive ratio | The ratio of logs to receive. This setting determines the number of logs to group together, out of which one is received. It reduces the number of logs you receive. The default value is -1, meaning no logs are received. For example, if you want to receive one log out of every five, change the value to 5. |
-1 |
| Max length in bytes | The maximum length of log messages, in bytes. | 32,766 |
| Character encoding | The character encoding for this data input. This field is read-only. | UTF-8 |
| Sub sample drop ratio | The ratio of logs to discard. This setting determines the number of logs to group together, out of which one is dropped. It reduces the number of fetched logs. The default value is -1: no logs are discarded. For example, if you want one log out of every five to be dropped, change the value to 5. |
-1 |
| Rate limit | The maximum number of events per second that this data input processes. | -1 |
| Default timezone | The default time zone of events. The system uses this default when the log does not specify a time zone. | GMT |
| Drop if queue is full | Option for selecting to discard logs if many processes are waiting in the queue to access the MID Server. | Clear |