Package: inb-django-influxdb-metrics
A reusable Django app that sends metrics about your project to InfluxDB.IMPORTANT NOTE: This release only supports InfluxDB >= 0.9. We have also dropped
a few measurements like CPU, memory and disk-space because
[Telegraf](https://github.com/influxdb/telegraf) can collect these in a much
much better way.PrerequisitesThis module has celery support but you don’t have to use it, if you don’t want
to.InstallationTo get the latest stable release from PyPipipinstalldjango-influxdb-metricsTo get the latest commit from GitHubpipinstall-egit+git://github.com/bitmazk/django-influxdb-metrics.git#egg=influxdb_metricsAddinfluxdb_metricsto yourINSTALLED_APPSINSTALLED_APPS=(...,'influxdb_metrics',)SettingsYou need to set the following settings:INFLUXDB_HOST = 'your.influxdbhost.com'
INFLUXDB_PORT = '8086'
INFLUXDB_USER = 'youruser'
INFLUXDB_PASSWORD = 'yourpassword'
INFLUXDB_DATABASE = 'yourdatabase'

# This is for tagging the data sent to your influxdb instance so that you
# can query by host
INFLUXDB_TAGS_HOST = 'your_hostname'

# Seconds to wait for the request to the influxdb server before timing out
INFLUXDB_TIMEOUT = 5

# Set this to True if you are using Celery
INFLUXDB_USE_CELERY = True

# Set this to True if you are not using Celery
INFLUXDB_USE_THREADING = FalseIf you would like to disable sending of metrics (i.e. for local development),
you can set:INFLUXDB_DISABLED = TrueIf you are having trouble getting the postgresql database size, you might need
to set:INFLUXDB_POSTGRESQL_USE_LOCALHOST = TrueUse ssl with INFLUXDB_HOST:INFLUXDB_SSL = True # default is FalseOptional with ssl:INFLUXDB_VERIFY_SSL = True # default is FalseUsageThe app comes with several management commands which you should schedule via
crontab.influxdb_get_postgresql_sizeCollects the total disk usage for the given database.You can run it like this:./manage.py influxdb_get_postgresql_size db_role db_nameYou should provide role and name for the database you want to measure. Make
sure that you have a.pgpassfile in place so that you don’t need to enter
a password for this user.You could schedule it like this:0 */1 * * * cd /path/to/project/ && /path/to/venv/bin/python /path/to/project/manage.py influxdb_get_postgresql_size db_role db_name > $HOME/mylogs/cron/influxdb-get-postgresql-size.log 2>&1The measurement created in your InfluxDB will be namedpostgresql_sizeand
will have the following fields:value: The total database size in bytesInfluxDbEmailBackendIf you would like to track the number of emails sent, you can set yourEMAIL_BACKEND:EMAIL_BACKEND = 'influxdb_metrics.email.InfluxDbEmailBackend'When the setting is set, metrics will be sent every time you run.manage.py send_mail.The measurement created in your InfluxDB will be nameddjango_email_sentand will have the following fields:value: The number of emails sentInfluxDBRequestMiddlewareIf you would like to track the number and speed of all requests, you can add
theInfluxDBRequestMiddlewareat the top of yourMIDDLEWARE_CLASSES:MIDDLEWARE_CLASSES = [
    'influxdb_metrics.middleware.InfluxDBRequestMiddleware',
    ...
]The measurement created in your InfluxDB will be nameddjango.requestand
will have the following fields:value: The request time in milliseconds.Additionally, it will have the following tags:is_ajax:trueif it was an AJAX request, otherwisefalseis_authenticated:trueif user was authenticated, otherwisefalseis_staff:trueif user was a staff user, otherwisefalseis_superuser:trueuser was a superuser, otherwisefalsemethod: The request method (GETorPOST)module: The python module that handled the requestview: The view class or function that handled the requestreferer: The full URL fromrequest.META[‘HTTP_REFERER’]referer_tld: The top level domain of the referer. It tries to be smartand regardsgoogle.co.ukas a top level domain (instead ofco.uk)full_path: The full path that was requestedpath: The path without GET params that was requestedcampaign: A value that is extracted from the GET-parametercampaign,
if present. You can change the name of this keyword fromcampaignto
anything via the settingINFLUXDB_METRICS_CAMPAIGN_KEYWORD.If you have a highly frequented site, this table could get big really quick.
You should make sure to create a shard with a low retention time for this
series (i.e. 7d) and add a continuous query to downsample the data into
hourly/daily averages. When doing that, you will obviously lose the detailed
information likerefererandreferer_tldbut it might make sense to
create a second continuous query to count and downsample at least thereferer_tldvalues.NOTE: I don’t know what impact this has on overall request time or how much
stress this would put on the InfluxDB server if you get thousands of requests.
It would probably wise to consider something like statsd to aggregate the
requests first and then send them to InfluxDB in bulk.Tracking UsersThis app’smodels.pycontains apost_saveand apost_deletehandler
which will detect when a user is created or deleted.It will create three measurements in your InfluxDB:The first one will be nameddjango_auth_user_createand will have the
following fields:value: 1The second one will be nameddjango_auth_user_deleteand will have the
following fields:value: 1The third one will be nameddjango_auth_user_countand will have the
following fields:value: The total number of users in the databaseTracking User LoginsThis app’smodels.pycontains a handler for theuser_logged_insignal.The measurement created in your InfluxDB will be nameddjango_auth_user_loginand will have the following fields:value: 1Making QueriesIf you need to get data out of your InfluxDB instance, you can easily do it
like so:from influxdb_metrics.utils import query
query('select * from series.name', time_precision='s', chunked=False)The method declaration is the same as the one inInfluxDBClient.query().
This wrapper simply instanciates a client based on your settings.ContributeIf you want to contribute to this project, please perform the following steps# Fork this repository
# Clone your forkmkvirtualenv-ppython2.7django-influxdb-metricsmakedevelopgitco-bfeature_branchmaster# Implement your feature and testsgitadd.&&gitcommitgitpush-uoriginfeature_branch# Send us a pull request for your feature branchRuning testsFor running the tests [Docker](https://docs.docker.com/) and
[Docker compose](https://www.docker.com/products/docker-compose) is required.The test setup a Influxdb database for testing against real queries.In order to run the tests just run the command:./run_tests_with_docker.sh