Observability Resource

Observability resource represents the configuration for logs server, traces server, and metrics server.

Field Description
Resource name Name of the Observability resource.

Logs Server

Note: The log server configuration is not enabled for control tower data planes.
Field Description
User Apps This includes apps deployed by TIBCO BusinessWorks 6 (Containers) and TIBCO Flogo capabilities.
Query Service configuration

The Log Server Query Service is a TIBCO Control Plane service that is responsible for retrieving user app logs that are persisted in the Logs server. It is used in the user app log viewer. The Query Service requires only read access to the Logs server.

You can enable or disable the Query Service configuration.
Query Service type

The following logs server Query Service types are available:

  • ElasticSearch

  • OpenSearch
Log Index

Specify the name of the index that matches the patterns of the Index template definition created on your Log server.

Example:

Log index: user-app-my-dataplane-xyz

Index pattern: user-app-*

Note: The asterisk (*) is not allowed in the index name.

You must create the log index for user app on the Log server. You must set the life cycle management policy such as the retention period and number of shards allocated for the index.
Endpoint Specify the Log server endpoint URL.
Username The user name to connect to the Logs server.
Password The password to connect to the Logs server.
Custom Header This allows custom headers to be passed to the Log server.
Key Specify a custom header key.
Value Specify the value of the header.
Test Connection Using Test Connection button, you can test the connection to the Logs server by using the configuration specified.
Primary Exporter Configuration

The Log Server Exporter for user apps is used in the OpenTelemetry Collector provisioned by TIBCO Control Plane. The OpenTelemetry Collector is responsible for exporting the logs emitted from the user app to the Logs server. The exporter requires write access to the Logs server.
Secondary Exporter Configuration

In addition to the primary exporter, you can now configure secondary exporter for logs, metrics, and traces. Secondary exporter supports OTLP type only.

Secondary exporter is enabled when:

  • A Primary Exporter is selected and type is not OTLP.
Enable or Disable Exporter Configuration You can enable or disable the exporter configuration. If disabled, user app logs are not exported to the Logs server.
Exporter name Specify a unique exporter name.
Exporter type

The following exporter types are available:

  • ElasticSearch

  • Kafka

  • OTLP
ElasticSearch
Log Index

Specify the name of the index that matches the patterns of the Index template definition created on your Log server.

Example:

Log index: user-app-my-dataplane-xyz

Index pattern: user-app-*

You must create the log index for user app on the Log server. You must set the life cycle management policy such as the retention period and number of shards allocated for the index.

Endpoint

 Specify the ElasticSearch endpoint URL.
Username Username to connect to the ElasticSearch server.
Password Password to connect to the ElasticSearch server.
Test Connection

Using the Test Connection button, you can test the connection to the ElasticSearch server by using the configuration specified.

Note: Test Connection button is enabled for data plane observability resource only.
Note: Test connection is available only for ElasticSearch and Prometheus query services and exporters for both.
Kafka
Brokers List of host and port pairs (host:port) for establishing the initial connection with the Kafka cluster. Enter TAB to add multiple brokers
Protocol version Version of Kafka protocol
Topic Kafka topic name
Username The user name to connect to the Kafka cluster
Password The password to connect to the Kafka cluster
OTLP
Type

The following transport system types are available:

  • http

  • grpc
Endpoint Target URL to which the exporter is going to send logs.

Services

Field Description
Exporter configuration

The Log Server Exporter for Services is used in the OpenTelemetry collector provisioned by TIBCO Control Plane. OpenTelemetry collector is responsible for exporting the logs emitted from the TIBCO provisioned services to the Logs server. The exporter requires write access to the Logs server.
Exporter name Specify a unique exporter name.
Exporter type

The following exporter types are available:

  • ElasticSearch

  • Kafka

  • OTLP
Enable or Disable Exporter Configuration

You can enable or disable the exporter configuration. If disabled, TIBCO service logs are not exported to the Logs server.

If fluentbit sidecar deployment is disabled when registering a data plane, Services exporter is disabled.
ElasticSearch
Log Index

Specify the name of the index that matches the patterns of the Index template definition created on your Log server.

Example:

Log index: user-app-my-dataplane-xyz

Index pattern: user-app-*

You must create the log index for user app on the Log server. You must set the life cycle management policy such as the retention period and number of shards allocated for the index.

Endpoint

 Specify the ElasticSearch endpoint URL.
Username Username to connect to the ElasticSearch server.
Password Password to connect to the ElasticSearch server.
Test Connection Using the Test Connection button, you can test the connection to the ElasticSearch server by using the configuration specified.
Kafka
Brokers List of host and port pairs (host:port) for establishing the initial connection with the Kafka cluster. Enter TAB to add multiple brokers
Protocol version Version of Kafka protocol
Topic Kafka topic name
Username The user name to connect to the Kafka cluster
Password The password to connect to the Kafka cluster
OTLP
Type

The following transport system types are available:

  • http

  • grpc
Endpoint Target URL to which the exporter is going to send logs

Metrics Server

Note: For new installation, you can view the options to use out of the box metrics and traces server on UI after registering at least one data plane. When upgrading from an earlier release, you must upgrade data plane to version 1.6.0 or later to view out of the box metrics and traces server options.
Field Description
Use Control Plane hosted Prometheus for Query Service and Exporter

If enabled, TIBCO Control Plane hosted Prometheus is used and you cannot bring your own Prometheus. If disabled, you can configure and use your Prometheus. Retention period for metrics data will be 24 hrs only.

By default this is enabled.

Query Service The Metrics Server Query Service is the TIBCO Control Plane Service that is responsible for retrieving metrics collected from user apps. These metrics are then persisted in the Prometheus server. It is used in both the Observability metrics cards and the Monitoring tab in the app details page. The Query Service requires only read access to the Prometheus server.
Query service name Specify unique name for Query Service
Query service type

Type of Query Service:

  • Prometheus
Endpoint The URL of the Prometheus endpoint.
Username Username to access the metrics server.
Password Password to access the metrics server.
Custom Header This allows custom headers to be passed to Metrics server.
Key Specify the custom header key.
Value Specify the value of the header.
Test Connection Using the Test Connection button, you can test the connection to the Prometheus by using the configuration specified.
Primary Exporter Configuration

The Metrics Server Exporter for user apps is used in the OpenTelemetry Collector provisioned by TIBCO Control Plane. The OpenTelemetry Collector is responsible for exporting the metrics emitted from the user app to the metrics server. The exporter requires write access to the metrics server.
Secondary Exporter Configuration

In addition to the primary exporter, you can now configure secondary exporter for logs, metrics, and traces. Secondary exporter supports OTLP type only.

Secondary exporter is enabled when:

  • A Primary Exporter is selected and type is not OTLP.

  • When using Control Plane hosted Prometheus for Query Service and Exporter, Primary Exporter is disabled, but Secondary Exporter can be enabled.
Enable or Disable Exporter Configuration You can enable or disable the exporter configuration. If disabled, user app metrics are not exported to the metrics server.
Exporter name Specify a unique exporter name.
Exporter type

Type of exporter:

  • Kafka

  • OTLP

  • Prometheus
Kafka
Brokers List of host and port pairs (host:port) for establishing the initial connection with the Kafka cluster. Enter TAB to add multiple brokers.
Protocol version Version of Kafka protocol
Topic Kafka topic name
OTLP
Type

Type of transport system:

  • http

  • grpc
Endpoint Target URL to which the exporter is going to send metrics.
Prometheus Use Prometheus as an exporter to export metrics from user apps.
Note: TIBCO Control Plane supports VictoriaMetrics along with Prometheus for metrics server configuration.

Traces Server

Note: For new installation, you can view the options to use out of the box metrics and traces server on UI after registering at least one data plane. When upgrading from an earlier release, you must upgrade data plane to version 1.6.0 or later to view out of the box metrics and traces server options.
Field Description
Use Local Store on Data Plane for Query Service and Exporter

If enabled, local store on data plane is used and you cannot bring your own storage to store traces. If disabled, you can configure and use your own storage to store traces.

By default, this is enabled.

Trace data is temporarily stored in the jaeger-allinone pod within the Data Plane namespace. Restarting this pod, regardless of the cause (reconfiguring Observability at the data plane level or manual pod restart) will result in the loss of all trace data stored within it. Therefore, trace data is not persistent after pod restarts.
Query Service The Traces Server Query Service is the TIBCO Control Plane Service that is responsible for retrieving traces collected from user apps. These traces are persisted in the Traces server. You can enable or disable the query service.
Query Service name Specify a unique name for Query Service
Query Service type

Type of Query Service:

  • ElasticSearch

  • OpenSearch
Endpoint Specify a query service endpoint URL.
Username Username to connect to the Traces server.
Password Password to connect to the Traces server.
Test Connection Using the Test Connection button, you can test the connection to the Traces server by using the configuration specified.
Primary Exporter Configuration

The Traces Server Exporter for user apps is used in the OpenTelemetry Collector provisioned by TIBCO Control Plane. The OpenTelemetry Collector is responsible for exporting the Traces emitted from the user app to the Traces server. The exporter requires write access to the Traces server.
Secondary Exporter Configuration

In addition to the primary exporter, you can now configure secondary exporter for logs, metrics, and traces. Secondary exporter supports OTLP type only.

Secondary exporter is enabled when:

  • A Primary Exporter is selected and type is not OTLP.

  • When using Local Store on Data Plane for Query Service and Exporter, Primary Exporter is disabled, but Secondary Exporter can be enabled.
Enable or Disable Exporter Configuration You can enable or disable the exporter configuration. If disabled, user app Traces are not exported to the Traces server.
Exporter name Specify a unique exporter name.
Exporter type

Type of exporter:

  • ElasticSearch

  • Kafka

  • OTLP
ElasticSearch

Endpoint

 Specify the ElasticSearch endpoint URL.
Username Username to connect to the ElasticSearch server.
Password Password to connect to the ElasticSearch server.
Test Connection Using the Test Connection button, you can test the connection to the Traces server by using the configuration specified.
Kafka
Brokers List of host and port pairs (host:port) for establishing the initial connection with the Kafka cluster. Enter TAB to add multiple brokers
Protocol version Version of Kafka protocol
Topic Kafka topic name
Username Username to connect to the Kafka cluster
Password Password to connect to the Kafka cluster
OTLP
Type

Transport type:

  • http

  • grpc
Endpoint Target URL to which the exporter is going to send traces.