PostgreSQL

The data collector will validate and add information about a PostgreSQL server to a support bundle.

Parameters

The data collector has the following parameters:

collectorName (Recommended)

The name of the collector. This is recommended to set to a string identifying the PostgreSQL instance, and can be used to refer to this collector in analyzers and preflight checks. If unset, this will be set to the string "postgres".

uri (Required)

The connection URI to use when connecting to the PostgreSQL server.

Example Collector Definition

apiVersion: troubleshoot.sh/v1beta2
kind: SupportBundle
metadata:
  name: sample
spec:
  collectors:
    - postgres:
        collectorName: pg
        uri: postgresql://user:[email protected]:5432/defaultdb?sslmode=require

Note: troubleshoot.sh/v1beta2 was introduced in preflight and support-bundle krew plugin version 0.9.39 and Kots version 1.19.0. Kots vendors should read the guide to maintain backwards compatibility.

Included resources

A single JSON file will be added to the support bundle, in the path /postgres/[collector-name].json:

{
    "isConnected": false,
    "error": "invalid password",
    "version": "10.12",
}

Fields

isConnected

a boolean indicating if the collector was able to connect and authenticate using the connection string provided.

error

a string that indicates the connection error, if there was one

version

when connected, a string indicating the version of PostgreSQL that's running