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
| Field | Description |
|---|---|
| User Apps | This includes apps deployed by BWCE and Flogo capabilities. |
| Log Index |
Specify the name of the index that matches the patterns of the Index template definition created on your Elasticsearch server. Example: Log index: Index pattern: You must create the log index for user app on the Elasticsearch server. You need to set the life cycle management policy such as the retention period and number of shards allocated for the index. |
| Proxy | The Log Server Proxy is TIBCO Control Plane service that is responsible for retrieving user app logs that are persisted in the Elasticsearch server. It is used in the user app log viewer. The proxy requires only read access to the Elasticsearch server. |
| Endpoint | The URL of the network proxy that provides access to the Elasticsearch endpoint URL. |
| Username | Username to connect to the Elasticsearch server. |
| Password | Password to connect to the Elasticsearch server. |
| Custom Header | This allows custom headers to be passed to Log server. |
| Key | Specify a custom header key. |
| Value | Specify the value of the header. |
| Exporter |
The Log Server Exporter for user apps is used in the OpenTelemetry Collector provisioned by TIBCO Control Plane that is responsible for exporting the logs emitted from the user app to the Elasticsearch server. The exporter requires write access to the Elasticsearch server. |
| Enable or Disable Exporter Configuration | You can enable or disable exporter configuration. If disabled, user app logs are not exported to Elasticsearch server. |
| Endpoint | The URL of the network proxy that provides access to the Elasticsearch endpoint URL. |
| Username | Username to connect to the Elasticsearch server. |
| Password | Password to connect to the Elasticsearch server. |
| Custom Header | This allows custom headers to be passed to Log server. |
| Key | Specify the custom header key. |
| Value | Specify the value of the header. |
| Services | |
| Exporter |
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 Elasticsearch server. The exporter requires write access to the Elasticsearch server. |
| Enable or Disable Exporter Configuration |
You can enable or disable exporter configuration. If disabled, TIBCO services logs are not exported to Elasticsearch server. If fluentbit sidecar deployment is disabled when registering a data plane, Services exporter is disabled. |
| Endpoint | The URL of the network proxy that provides access to the Elasticsearch endpoint URL. |
| Username | Username to connect to the Elasticsearch server. |
| Password | Password to connect to the Elasticsearch server. |
Traces Server
| Field | Description |
|---|---|
| Enable or Disable Tracing | You can enable or disable tracing by using this option. |
| Endpoint |
The URL of the network proxy that provides access to the Traces server endpoint URL. You must create the trace index for user app on the Elasticsearch server. You must set the life cycle management policy such as the retention period and number of shards allocated for the index. |
| Username | Username to connect to the Elasticsearch server. |
| Password | Password to connect to the Elasticsearch server. |
Metrics Server
| Field | Description |
|---|---|
| Proxy | The Metrics Server Proxy is the TIBCO Control Plane Service that is responsible for retrieving metrics collected from user apps that are persisted in the Prometheus server. It is used in both the Observability metrics cards and the Monitoring tab in the app details page. The proxy requires only read access to the Prometheus server. |
| Endpoint | The URL of the network proxy that provides access to 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. |