Geneos ["Geneos"]

Obcerv Connection

Overview

This technical reference provides information about the configuration of the Obcerv connection top-level section.

For a step-by-step setup guide, see Obcerv Quickstart Guide.

For information about sampler configuration, see Samplers.

Basic configuration

The Obcerv connection section of the GSE provides the following options:

Setting Description Default
Enabled Enables or disables publishing to Obcerv. Disabled
Mode

Specify the publishing mode, choose from:

  • connection — publish Gateway data to Obcerv.

  • statisticsOnly — perform a dry run using the current publishing settings. Statistics are recorded to the self monitoring dataviews and to log files.

connection
     

If the Mode is set to connection then you can set up:

  • Publishing — configure publishing from this Gateway to Obcerv.

  • Data Access — allow an Active Console connected to this Gateway to access Obcerv data.

Section Setting Description
Connection Verify server certificate

Enables or disables the server certificate verification.

If this parameter is set to false and the TLS is enabled, then the server certificate will not be checked when the connection is made, and the provided certificate will be accepted.

Default: True

Connection Root certificates

Specify the root CA certificate used to sign the ingestion service certificate.

You can provide:

  • pemString — provide the full PEM string of the CA certificate. This can be found in the certificates page of the Obcerv Admin page in your Web Console.

  • pemFile — provide the path to a file in the Gateway's current working directory. This file should contain the full PEM string of the CA certificate.

A root certificate is not required if the certificate is already trusted by the host.

Connection > Publishing Service address Specify the Obcerv ingestion service hostname with the http:// prefix. For example https://ingestion.my-obcerv.com.
Connection > Publishing Credentials

Specify the credentials used to access the Obcerv ingestion service.

You should provide a username and password in the Gateway Setup Editor. For more information about password configuration, see Secure Passwords.

Connection > Data access Service address Specify the Obcerv Web Console hostname. For example https://my-obcerv.com.
Connection > Data access Credentials

Specify the Obcerv user credentials to access data from Obcerv.

You should provide a username and password in the Gateway Setup Editor. For more information about password configuration, see Secure Passwords.

     

Advanced configuration

The Additional settings allows you to specify the following additional publishing settings that you may set individually:

Settings Description
grpc.rpc.timeout

The time the Gateway waits for a gRPC response.

Default: 5000

Unit: milliseconds

Mandatory: No

grpc.batch.timeout

The time the Gateway waits before sending a batch of datapoints to Obcerv.

Default: 500

Unit: milliseconds

Mandatory: No

grpc.batch.size

The maximum size a datapoint batch can have. Once the batch reaches the given size, it will be sent to Obcerv.

Default: 1000

Unit: datapoints

Mandatory: No

grpc.queue.size

The number of messages the Gateway can hold before it starts dropping message. This queue holds messages before being sent to Obcerv. The Gateway will attempt to keep this queue as small a possible.

Default: 50000

Mandatory: No

   

Strategies

Setting Description Default
Name Specifies a name to uniquely identify the strategy. New Strategy
Targets

One or more XPaths identifying the data items to which the strategy applies.

These XPaths must point to one or more Netprobes, Managed Entities, samplers, or dataviews. XPaths that reference run-time values such as severity or connection state, or XPaths that point to individual cells are not supported.

 
Options

Specifies what type of strategy to use. The following options are available:

  • include filter — publish only the data items specified by the targets, their ancestors, and their descendants. The metrics, severity messages, snooze messages, and user assignment messages of all data items not explicitly or implicitly targeted are not published. Severity is propagated through published data based only on included data items.

  • exclude filter — do not publish the data items specified by the targets or their descendants. Metrics, severity messages, snooze messages, and user assignment messages are not published for any targeted data items. Severity is propagated through published data based only on data items which are not excluded.

    Note: If you specify both include filters and exclude filters, a data item is published if it is selected (directly or as an ancestor or descendant) by at least one include target and it is not selected (directly or as a descendant) by any exclude target.

filter
     

Strategy Group

Strategies may be grouped for organisational purposes. This has no effect on their application but is useful for grouping categories and making them easier to find in the navigation tree.

You must specify a name when creating a strategy group.