GCP PubSub integration configuration fields
Summarize
Summary of GCP PubSub Integration Configuration Fields
This document outlines the configuration fields necessary for setting up GCP PubSub integration for Health Log Analytics in ServiceNow. It includes essential fields and their descriptions to ensure a successful integration process.
Show less
Key Features
- Integration Name: A unique identifier for the integration, which automatically adjusts the displayed name on the form.
- Service Instance: Required field to bind log data to a specific service instance.
- Execute On: Choose between a specific MID Server or a MID Server cluster for log processing.
- MID Server Selection: Allows selection of a MID Server with necessary log ingestion capabilities, automatically enabling it if not already set up.
- Source: Indicates the log data source, which is read-only and set to PubSub.
- Project ID: Required field to specify the Google Cloud project.
- Authentication Method: Credential alias used for access, with the option to manage additional aliases.
- Topic and Subscription Names: Required fields to identify the Pub/Sub topic and subscription for log data retrieval.
- Advanced Settings: Options to configure subscriber thread pool size, log sampling ratios, and queue handling preferences.
Key Outcomes
By accurately configuring these fields, ServiceNow customers can effectively integrate GCP PubSub with Health Log Analytics, ensuring reliable log data processing and management. Proper setup allows for optimized log ingestion, enhanced monitoring capabilities, and streamlined operations within the ServiceNow platform.
Description of the fields on the GCP PubSub integration configuration forms for Health Log Analytics.
For the GCP PubSub integration setup procedure, see Set up a GCP PubSub integration 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 select whether to use a specific MID Server or a MID Server cluster. This field is required. |
| 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 Execute on is set to Specific MID Server cluster.) The MID Server cluster to which the log data is pulled. This field is required.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. Note: For more information about MID Server clusters, see Configure a MID Server cluster.
|
| 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 to discard logs if many processes are waiting in the queue to access the MID Server. | Clear |