Puppet Class: thanos::query_frontend

Defined in:
manifests/query_frontend.pp

Summary

This class manages query frontend service

Overview

This class install Query Frontend as service that can be put in front of Thanos Queriers to improve the read path.

Examples:

include thanos::query

Parameters:

  • ensure (Enum['present', 'absent']) (defaults to: 'present') —

    State ensured from compact service.

  • user (String) (defaults to: $thanos::user) —

    User running thanos.

  • group (String) (defaults to: $thanos::group) —

    Group under which thanos is running.

  • bin_path (Stdlib::Absolutepath) (defaults to: $thanos::bin_path) —

    Path where binary is located.

  • log_level (Thanos::Log_level) (defaults to: 'info') —

    Only log messages with the given severity or above. One of: [debug, info, warn, error, fatal]

  • log_format (Enum['logfmt', 'json']) (defaults to: 'logfmt') —

    Output format of log messages. One of: [logfmt, json]

  • tracing_config_file (Optional[Stdlib::Absolutepath]) (defaults to: $thanos::tracing_config_file) —

    Path to YAML file with tracing configuration. See format details: thanos.io/tracing.md/#configuration

  • query_range_split_interval (String) (defaults to: '24h') —

    Split queries by an interval and execute in parallel, 0 disables it.

  • query_range_max_retries_per_request (Integer) (defaults to: 5) —

    Maximum number of retries for a single request; beyond this, the downstream error is returned.

  • query_range_max_query_length (Integer) (defaults to: 0) —

    Limit the query time range (end - start time) in the query-frontend, 0 disables it.

  • query_range_max_query_parrallelism (Integer) (defaults to: 14) —

    Maximum number of queries will be scheduled in parallel by the frontend.

  • query_range_response_cache_max_freshness (String) (defaults to: '1m') —

    Most recent allowed cacheable result, to prevent caching very recent results that might still be in flux.

  • query_range_partial_response (Boolean) (defaults to: false) —

    Enable partial response for queries if no partial_response param is specified. –no-query-range.partial-response for disabling.

  • query_range_response_cache_config_file (Optional[Stdlib::Absolutepath]) (defaults to: undef) —

    Path to YAML file that contains response cache configuration.

  • http_address (String) (defaults to: '0.0.0.0:10902') —

    Listen host:port for HTTP endpoints.

  • http_grace_period (String) (defaults to: '2m') —

    Time to wait after an interrupt received for HTTP Server.

  • query_frontend_downstream_url (Stdlib::HTTPUrl) (defaults to: 'http://localhost:9090') —

    URL of downstream Prometheus Query compatible API.

  • query_frontend_compress_responses (Boolean) (defaults to: false) —

    Compress HTTP responses.

  • query_frontend_log_queries_longer_than (String) (defaults to: "0") —

    Log queries that are slower than the specified duration. Set to 0 to disable. Set to < 0 to enable on all queries.

  • log_request_decision (Optional[String]) (defaults to: undef) —

    Request Logging for logging the start and end of requests. LogFinishCall is enabled by default.

    LogFinishCall : Logs the finish call of the requests.
LogStartAndFinishCall : Logs the start and finish call of the requests.
NoLogCall : Disable request logging.
  • max_open_files (Optional[Integer]) (defaults to: undef) —

    Define how many open files the service is able to use In some cases, the default value (1024) needs to be increased

  • extra_params (Hash) (defaults to: {}) —

    Parameters passed to the binary, ressently released in latest version of Thanos.

  • env_vars (Array) (defaults to: []) —

    Environment variables passed during startup. Useful for example for ELASTIC_APM tracing integration.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'manifests/query_frontend.pp', line 57

class thanos::query_frontend (
  Enum['present', 'absent']      $ensure                                   = 'present',
  String                         $user                                     = $thanos::user,
  String                         $group                                    = $thanos::group,
  Stdlib::Absolutepath           $bin_path                                 = $thanos::bin_path,
  Optional[Integer]              $max_open_files                           = undef,
  # Binary Parameters
  Thanos::Log_level              $log_level                                = 'info',
  Enum['logfmt', 'json']         $log_format                               = 'logfmt',
  Optional[Stdlib::Absolutepath] $tracing_config_file                      = $thanos::tracing_config_file,
  String                         $query_range_split_interval               = '24h',
  Integer                        $query_range_max_retries_per_request      = 5,
  Integer                        $query_range_max_query_length             = 0,
  Integer                        $query_range_max_query_parrallelism       = 14,
  String                         $query_range_response_cache_max_freshness = '1m',
  Boolean                        $query_range_partial_response             = false,
  Optional[Stdlib::Absolutepath] $query_range_response_cache_config_file   = undef,
  String                         $http_address                             = '0.0.0.0:10902',
  String                         $http_grace_period                        = '2m',
  Stdlib::HTTPUrl                $query_frontend_downstream_url            = 'http://localhost:9090',
  Boolean                        $query_frontend_compress_responses        = false,
  String                         $query_frontend_log_queries_longer_than   = "0",
  Optional[String]               $log_request_decision                     = undef,
  # Extra parametes
  Hash                           $extra_params                             = {},
  Array                          $env_vars                                 = [],
) {
  $_service_ensure = $ensure ? {
    'present' => 'running',
    default   => 'stopped'
  }

  thanos::resources::service { 'query-frontend':
    ensure         => $_service_ensure,
    bin_path       => $bin_path,
    user           => $user,
    group          => $group,
    max_open_files => $max_open_files,
    params         => {
      'log.level'                                => $log_level,
      'log.format'                               => $log_format,
      'tracing.config-file'                      => $tracing_config_file,
      'query-range.split-interval'               => $query_range_split_interval,
      'query-range.max-retries-per-request'      => $query_range_max_retries_per_request,
      'query-range.max-query-length'             => $query_range_max_query_length,
      'query-range.max-query-parallelism'        => $query_range_max_query_parrallelism,
      'query-range.response-cache-max-freshness' => $query_range_response_cache_max_freshness,
      'query-range.partial-response'             => $query_range_partial_response,
      'query-range.response-cache-config-file'   => $query_range_response_cache_config_file,
      'http-address'                             => $http_address,
      'http-grace-period'                        => $http_grace_period,
      'query-frontend.downstream-url'            => $query_frontend_downstream_url,
      'query-frontend.compress-responses'        => $query_frontend_compress_responses,
      'query-frontend.log-queries-longer-than'   => $query_frontend_log_queries_longer_than,
      'log.request.decision'                     => $log_request_decision,
    },
    extra_params   => $extra_params,
    env_vars       => $env_vars,
  }
}