Opsgenie Python SDK Configurations

Configuration

Default Value

Definition

api_key

Empty

Dict to store API key(s)

api_key_prefix

Empty

Dict to store API prefix (e.g. Bearer)

api_key_prefix['Authorization']

GenieKey

Default dict for API prefix

username

Empty

Username for HTTP basic authentication

password

Empty

Password for HTTP basic authentication

logger

Empty

Dict to store logging settings

logger["package_logger"]

logging.getLogger("opsgenie_sdk")

Default value in logger settings dict

logger["urllib3_logger"]

logging.getLogger("urllib3")

Default value in logger settings dict

logger_format

%(asctime)s %(levelname)s %(message)s

Log format

logger_stream_handler

Empty

Log stream handler

logger_file_handler

Empty

Log file handler

logger_file

Empty

Debug file location

debug

Empty

Debug switch

retry_count

5

Number of retries allowed

retry_delay

0

Delay time between attempts

retry_max_delay

Empty

Maximum amount of delay

back_off

1

Multiplier applied to delay between attempts

retry_http_response

['5xx', '429']

Http status codes on which to perform retry

retry_enabled

True

Retry switch

verify_ssl

True

Switch to verifying SSL certificate when calling API from HTTPs server

ssl_ca_cert

Empty

Customize the certificate file to verify the peer.

cert_file

Empty

Client certificate file

key_file

Empty

Client key file

assert_hostname

Empty

Switch to enable SSL hostname verification

connection_pool_maxsize

multiprocessing.cpu_count() * 5

urllib3 connection pool's maximum number of connections saved per pool. urllib3 uses 1 connection as default value, but this is not the best value when you are making a lot of possibly parallel requests to the same host, which is often the case here. cpu_count * 5 is used as default value to increase performance.

proxy

Empty

Proxy URL

proxy_headers

Empty

Proxy headers

safe_chars_for_path_param

Empty

Safe chars for path_param

retries

Empty

Adding retries to override urllib3 default value 3

metrics_transaction_id

Empty

Metric transaction ids.

short_polling_max_retries

10

host

https://api.opsgenie.com

Base url to connect to Opsgenie services

temp_folder_path

Empty

Temp file folder for downloading files


Did this page help you?