Kingbase

·

Kingbase collector can collect the running status index from Kingbase instance.

Configuration¶

Preconditions¶

• Create user

-- Create monitor user
CREATE USER datakit with password 'datakit';
-- Grant (compatible with different versions)
DO $$
BEGIN
    BEGIN
        GRANT sys_monitor TO datakit;
        RAISE NOTICE 'granted sys_monitor';
    EXCEPTION WHEN undefined_object THEN
        GRANT pg_monitor TO datakit;
        RAISE NOTICE 'granted pg_monitor';
    END;
END $$;

• Enable sys_stat_statements extended logging

Edit the kingbase.conf configuration file and change the value of sys_stat_statements.track to top. If this configuration item is not found, add it at the end of the file.

# Track statistics of SQL statement access, recommended 'top', default is 'none'
# Old parameter (V8R5 or early V8R6)
# pg_stat_statements.track = 'top'

# New parameter
sys_stat_statements.track = 'top'

Collector Configuration¶

[[inputs.kingbase]]
  # host name
  host = "localhost"

  ## port
  port = 54321

  ## user name
  user = "datakit"

  ## password
  password = "datakit"

  ## database name
  database = "test"

  ## Slow query threshold in milliseconds, default 1000
  slow_query_threshold = 1000

  ## @param connect_timeout - number - optional - default: 10s
  # connect_timeout = "10s"

  interval = "10s"

  ## Set true to enable election
  election = true

  ## Metric name in metric_exclude_list will not be collected.
  #
  metric_exclude_list = [""]

  ## Run a custom SQL query and collect corresponding metrics.
  #
  # [[inputs.kingbase.custom_queries]]
  #   sql = "SELECT datname AS db, numbackends AS backends FROM sys_catalog.sys_stat_database"
  #   metric = "kingbase_custom_query"
  #   tags = ["db"]
  #   fields = ["backends"]
  #   interval = "30s"

  ## Log collection
  #
  [inputs.kingbase.log]
    # files = []
    # pipeline = "kingbase.p"
    ## The pattern should be a regexp. Note the use of '''this regexp'''
    ## regexp link: https://golang.org/pkg/regexp/syntax/#hdr-Syntax
    multiline_match = '''^\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}\\s+\\[.*?\\]'''

  [inputs.kingbase.tags]
    # some_tag = "some_value"
    # more_tag = "some_other_value"

Metric¶

For all of the following data collections, the global election tags will added automatically, we can add extra tags in [inputs.kingbase.tags] if needed:

kingbase_connections¶

kingbase_transactions¶

kingbase_query_performance¶

kingbase_locks¶

kingbase_query_stats¶

kingbase_buffer_cache¶

kingbase_database_status¶

kingbase_tablespace¶

kingbase_lock_details¶

kingbase_index_usage¶

kingbase_bgwriter¶

kingbase_session_activity¶

kingbase_query_cancellation¶

kingbase_function_stats¶

kingbase_slow_query¶

Custom Object¶

Log Collection¶

• To enable Kingbase runtime logging, configure the Kingbase configuration file kingbase.conf in the data directory as follows:

log_destination = 'stderr'

logging_collector = on
log_directory = 'sys_log'

• The Kingbase collector does not have log collection enabled by default. You can open files in conf.d/db/kingbase.conf and write to the absolute path of the Kingbase log file. For example:

[[inputs.kingbase]]

  ...

  [inputs.kingbase.log]
  files = ["/tmp/kingbase.log"]

When log collection is turned on, a log with a log source of kingbase is generated by default.

Notices:

• Log collection only supports logs on hosts where DataKit is installed.

Log Pipeline Cut¶

The original log is

2025-06-17 13:07:10.952 UTC [999] ERROR:  relation "sys_stat_activity" does not exist at character 240

Description of the cut field: