/usr/lib/python3/dist-packages/gnocchi/opts.py is in python3-gnocchi 4.2.0-0ubuntu5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 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 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 | # -*- encoding: utf-8 -*-
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import copy
import itertools
import operator
import pkg_resources
import uuid
from oslo_config import cfg
import gnocchi.archive_policy
import gnocchi.common.redis
import gnocchi.indexer
import gnocchi.storage
import gnocchi.storage.ceph
import gnocchi.storage.file
import gnocchi.storage.s3
import gnocchi.storage.swift
# NOTE(sileht): The oslo.config interpolation is buggy when the value
# is None, this replaces it by the expected empty string.
# Fix will perhaps be fixed by https://review.openstack.org/#/c/417496/
# But it seems some projects are relaying on the bug...
class CustomStrSubWrapper(cfg.ConfigOpts.StrSubWrapper):
def __getitem__(self, key):
value = super(CustomStrSubWrapper, self).__getitem__(key)
if value is None:
return ''
return value
cfg.ConfigOpts.StrSubWrapper = CustomStrSubWrapper
_STORAGE_OPTS = list(itertools.chain(gnocchi.storage.OPTS,
gnocchi.storage.ceph.OPTS,
gnocchi.storage.file.OPTS,
gnocchi.storage.swift.OPTS,
gnocchi.common.redis.OPTS,
gnocchi.storage.s3.OPTS))
_INCOMING_OPTS = copy.deepcopy(_STORAGE_OPTS)
for opt in _INCOMING_OPTS:
opt.default = '${storage.%s}' % opt.name
API_OPTS = (
cfg.HostAddressOpt('host',
default="0.0.0.0",
help="Host to listen on"),
cfg.PortOpt('port',
default=8041,
help="Port to listen on"),
cfg.StrOpt('uwsgi-mode',
default='http',
choices=["http", "http-socket", "socket"],
help="""Socket type to use for uWSGI:
* http: support HTTP/1.1 and keepalive,
but not chunked encoding (InfluxDB)
* http-socket/socket: support chunked encoding, but require a upstream HTTP
Server for HTTP/1.1, keepalive and HTTP protocol correctness.
""")
)
_cli_options = (
cfg.BoolOpt(
'debug',
short='d',
default=False,
help='If set to true, the logging level will be set to DEBUG.'),
cfg.BoolOpt(
'verbose',
short='v',
default=True,
help='If set to true, the logging level will be set to INFO.'),
cfg.StrOpt(
"log-dir",
help="Base directory for log files. "
"If not set, logging will go to stderr."),
cfg.StrOpt(
'log-file',
metavar='PATH',
help='(Optional) Name of log file to send logging output to. '
'If no default is set, logging will go to stderr as '
'defined by use_stderr.'),
)
def list_opts():
return [
("DEFAULT", _cli_options + (
cfg.StrOpt(
'coordination_url',
secret=True,
deprecated_group="storage",
help='Coordination driver URL'),
cfg.IntOpt(
'parallel_operations',
min=1,
deprecated_name='aggregation_workers_number',
deprecated_group='storage',
help='Number of threads to use to parallelize '
'some operations. '
'Default is set to the number of CPU available.'),
cfg.BoolOpt(
'use-syslog',
default=False,
help='Use syslog for logging.'),
cfg.BoolOpt(
'use-journal',
default=False,
help='Enable journald for logging. '
'If running in a systemd environment you may wish '
'to enable journal support. Doing so will use the '
'journal native protocol which includes structured '
'metadata in addition to log messages.'),
cfg.StrOpt(
'syslog-log-facility',
default='user',
help='Syslog facility to receive log lines.')
)),
("indexer", gnocchi.indexer.OPTS),
("metricd", (
cfg.IntOpt('workers', min=1,
required=True,
help='Number of workers for Gnocchi metric daemons. '
'By default the available number of CPU is used.'),
cfg.IntOpt('metric_processing_delay',
default=60,
required=True,
deprecated_group='storage',
help="How many seconds to wait between "
"scheduling new metrics to process"),
cfg.BoolOpt(
'greedy', default=True,
help="Allow to bypass `metric_processing_delay` if metricd "
"is notified that measures are ready to be processed."
),
cfg.IntOpt('metric_reporting_delay',
deprecated_group='storage',
default=120,
min=-1,
required=True,
help="How many seconds to wait between "
"metric ingestion reporting. Set value to -1 to "
"disable reporting"),
cfg.IntOpt('metric_cleanup_delay',
deprecated_group='storage',
default=300,
required=True,
help="How many seconds to wait between "
"cleaning of expired data"),
cfg.IntOpt('processing_replicas',
default=3,
min=1,
help="Number of workers that share a task. A higher "
"value may improve worker utilization but may also "
"increase load on coordination backend. Value is "
"capped by number of workers globally."),
)),
("api", (
cfg.StrOpt('paste_config',
default="api-paste.ini",
help='Path to API Paste configuration.'),
cfg.StrOpt('auth_mode',
default="basic",
choices=list(map(operator.attrgetter("name"),
pkg_resources.iter_entry_points(
"gnocchi.rest.auth_helper"))),
help='Authentication mode to use.'),
cfg.IntOpt('max_limit',
default=1000,
required=True,
help=('The maximum number of items returned in a '
'single response from a collection resource')),
cfg.IntOpt('operation_timeout',
deprecated_name="refresh_timeout",
default=10, min=0,
help='Number of seconds before timeout when attempting '
'to do some operations.'),
) + API_OPTS,
),
("storage", _STORAGE_OPTS),
("incoming", _INCOMING_OPTS),
("statsd", (
cfg.HostAddressOpt('host',
default='0.0.0.0',
help='The listen IP for statsd'),
cfg.PortOpt('port',
default=8125,
help='The port for statsd'),
cfg.Opt(
'resource_id',
type=uuid.UUID,
help='Resource UUID to use to identify statsd in Gnocchi'),
cfg.StrOpt(
'creator',
help='Creator value to use to identify statsd in Gnocchi'),
cfg.StrOpt(
'archive_policy_name',
help='Archive policy name to use when creating metrics'),
cfg.FloatOpt(
'flush_delay',
default=10,
help='Delay between flushes'),
)),
("archive_policy", gnocchi.archive_policy.OPTS),
]
def set_defaults():
from oslo_middleware import cors
cfg.set_defaults(cors.CORS_OPTS,
allow_headers=[
'Authorization',
'X-Auth-Token',
'X-Subject-Token',
'X-User-Id',
'X-Domain-Id',
'X-Project-Id',
'X-Roles'])
|