GCP PubSub data input configuration fields
Summarize
Summary of GCP PubSub Data Input Configuration Fields
The GCP PubSub data input configuration allows ServiceNow customers to set up log data ingestion from Google Cloud Pub/Sub. This configuration is essential for efficient log management and analytics, enabling users to monitor and analyze log data effectively.
Show less
Key Features
- Name: Required field for the data input's name.
- Port: Select a unique port for the MID Server; ensure it is opened by the security team.
- Execute on: Choose between a specific MID Server or a MID Server cluster.
- MID Server: For specific MID Server selection; supports only those with log ingestion capability and basic authentication.
- MID Server Cluster: For clusters, supports failover, must include MID Servers capable of basic authentication.
- Service Instance: Required binding for the log data; ensure the instance is operational.
Advanced Configuration
- Subscriber Thread Pool Size: Controls concurrent threads for downloading files (default is 1).
- Default Timezone: Sets the default timezone for events.
- Max Length in Bytes: Limits log message size to 32,766 bytes.
- Character Encoding: Read-only, set to UTF-8.
- Sub Sample Drop Ratio: Controls event drop ratio; set to -1 for default behavior.
- Rate Limit: Defines max events processed per second; set to -1 for default.
- Drop if Queue is Full: Option to discard logs under high queue load.
Key Outcomes
By configuring the GCP PubSub data input, ServiceNow customers can effectively manage log data ingestion, ensuring real-time analytics and operational monitoring. Proper setup enhances log processing efficiency and supports organizational security compliance.
Description of the fields on the GCP PubSub data input configuration form.
Basic configuration
| Field | Description |
|---|---|
| Name | Name of the new data input. This field is required. |
| Port | The port for the MID Server. Select a unique port from the array. The placeholder shows the range of ports from which to choose. Make sure that your organization’s security team opens the selected port. 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 |
(Only when the Execute on field 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.
|
| Service instance | The service instance to which to bind the log data. This field is required. Note:
If no relevant service instance exists, Create an service instance and add CIs to it. Set the status of the new service instance to Operational. |
The fields in the following table show read-only information.
| Field | Description |
|---|---|
| Transport | Protocol used to send the log data: PubSub. |
| Sources count | The number of log sources this data input has created. |
| Status | Status of the data input. |
| Disabled since | The time when the data input stopped or failed. |
| Last log time | The time when the last log streamed in the data input. |
| Field | Description |
|---|---|
| Project ID | The project ID of the Google Cloud project. For example, my-project-id. |
| Topic Name | The Google Cloud Pub/Sub topic to which to subscribe Health Log Analytics. For example, my_topic. |
| GCP Credential Alias | The credential alias to be used. Specify one GCP credential alias by selecting the magnifying glass icon and then either selecting an existing credential alias from the Connection & Credential Aliases list, or selecting New to create a new record. The default is sn_occ.HLA_Credential_Alias. For information about creating a credential alias, see Credential aliases for Discovery. |
| 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. |
Advanced configuration
| 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 |
| Default timezone | The default time zone of events. The system uses this default when the log does not specify a time zone. | GMT |
| Max length in bytes | The maximum length of log messages, in bytes. | 32,766 |
| Character encoding | (Read-only) The character encoding for this data input. | UTF-8 |
| Sub sample drop ratio | The ratio of events to drop. | -1 |
| Sub sample receive ratio | The ratio of events to receive. | -1 |
| Rate limit | The maximum number of events per second that this data input processes. | -1 |
| Drop if queue is full | Option to discard logs if many processes are waiting in the queue to access the MID Server. | Clear |