Settings¶
Kaneda can be used with a settings file as the same way to use with Django. Simply define a
kanedasettings.py file with the backend or queue settings. Alternatively you can define the environment variable
DEFAULT_SETTINGS_ENVAR pointing to the desired settings filename.
With this you will be able to use Metrics class without passing parameters:
from kaneda import Metrics
metrics = Metrics()
metrics.gauge('answer_of_life', 42)
Backends settings¶
General¶
- BACKEND
Class name of the backend. Available options are:
kaneda.backends.ElasticsearchBackendkaneda.backends.MongoBackendkaneda.backends.LoggerBackendkaneda.backends.RethinkBackendkaneda.backends.InfluxBackend
Elasticsearch¶
- ELASTIC_INDEX_NAME
- Name of the Elasticsearch index used to store metrics data. Default name format will be app_name-YYYY.MM.DD.
- ELASTIC_APP_NAME
- Name of the app/project where metrics are used.
- ELASTIC_CONNECTION_URL
- Elasticsearch connection url (https://user:secret@localhost:9200).
- ELASTIC_HOST
- Server host.
- ELASTIC_PORT
- Server port.
- ELASTIC_USER
- HTTP auth username.
- ELASTIC_PASSWORD
- HTTP auth password.
- ELASTIC_TIMEOUT
- Elasticsearch connection timeout (seconds).
MongoDB¶
- MONGO_DB_NAME
- Name of the MongoDB database.
- MONGO_COLLECTION_NAME
- Name of the MongoDB collection used to store metric data.
- MONGO_CONNECTION_URL
- Mongo connection url (mongodb://localhost:27017/).
- MONGO_HOST
- Server host.
- MONGO_PORT
- Server port.
- MONGO_TIMEOUT
- MongoDB connection timeout (milliseconds).
RethinkDB¶
- RETHINK_DB
- Name of the RethinkDB database
- RETHINK_TABLE_NAME
- Name of the RethinkDB table. If this is not provided, it will be used the name of the metric.
- RETHINK_HOST
- Server host.
- RETHINK_PORT
- Server port.
- RETHINK_USER
- Auth username.
- RETHINK_PASSWORD
- Auth password.
- RETHINK_TIMEOUT
- RethinkDB connection timeout (seconds).
InfluxDB¶
- INFLUX_DATABASE
- Name of the InfluxDB database.
- INFLUX_CONNECTION_URL
- InfluxDB connection url (influxdb://username:password@localhost:8086/databasename).
- INFLUX_HOST
- Server host.
- INFLUX_PORT
- Server port.
- INFLUX_USERNAME
- Auth username.
- INFLUX_PASSWORD
- Auth password.
- INFLUX_TIMEOUT
- InfluxDB connection timeout (seconds).
Logger¶
- LOGGER_FILENAME
- Name of the file where logger will store the metrics.