Produits Entr'ouvert » w.c.s.

<page xmlns="http://projectmallard.org/1.0/"

      type="topic" id="settings-monitoring" xml:lang="fr">

<info>

  <link type="guide" xref="index#system-settings" />

  <revision docversion="0.1" date="2013-07-06" status="draft"/>

  <credit type="author">

    <name>Frédéric Péters</name>

    <email>fpeters@entrouvert.com</email>

  </credit>

  <desc>Intégration avec un serveur StatsD</desc>

</info>

<title>Surveillance et suivi applicatif</title>

<section id="statsd">

  <title>StatsD</title>

  <p>

    <app>w.c.s.</app> peut communiquer à un serveur <app>StatsD</app> une série

    d'informations concernant le traitement des requêtes HTTP et

    l'authentification des utilisateurs.

  </p>

  <p>

    L'adresse du serveur <app>StatsD</app> est récupérée d'une variable

    d'environnement nommée <var>QOMMON_STATSD_HOSTNAME</var> qui sera

    communément positionnée au niveau du serveur Web; par défaut

    <var>localhost</var> sera utilisé.

  </p>

  <listing>

    <title>Exemple de configuration Apache</title>

    <code>SetEnv QOMMON_STATSD_HOSTNAME statsd.example.net</code>

  </listing>

  <p>

    Les clés positionnées sont de la forme

    <code>wcs.<var>domaine</var>.<var>clé</var></code>, les points présents dans le

    nom de domaine remplacés par des tirets; par exemple

    <code>wcs.teleservices-example-net.login-error</code>.

  </p>

  <p>

    Les informations suivantes sont communiquées :

  </p>

  <table shade="rows">

    <tr>

      <td><p><code>login-submit</code></p></td>

      <td><p>Compteur incrémenté lors de la validation d'une page

      d'authentification</p></td>

    </tr>

    <tr>

      <td><p><code>login-error</code></p></td>

      <td><p>Compteur incrémenté lors d'une tentative d'authentification

      infructueuse.</p></td>

    </tr>

    <tr>

      <td><p><code>login-success</code></p></td>

      <td><p>Compteur incrémenté lors d'une tentative d'authentification

      réussie</p></td>

    </tr>

    <tr>

      <td><p><code>successful-request</code></p></td>

      <td><p>Compteur incrémenté à la fin d'une requête HTTP réussie</p></td>

    </tr>

    <tr>

      <td><p><code>failed-request</code></p></td>

      <td><p>Compteur incrémenté à la fin d'une requête HTTP avortée par

             une erreur interne (erreur HTTP 500)</p></td>

    </tr>

  </table>

</section>

</page>

        if self.statsd:

            self.statsd.udp_sock.close()

            self.statsd = None

        get_publisher().statsd.increment('login-submit')

            get_publisher().statsd.increment('login-error')

        get_publisher().statsd.increment('login-success')

    statsd = None

        self.statsd.increment('successful-request')

        if self.statsd: # maybe unset if very early failure

            self.statsd.increment('failed-request')

        from vendor import pystatsd

        self.statsd = pystatsd.Client(

                        host=request.get_environ('QOMMON_STATSD_HOSTNAME', 'localhost'),

                        prefix='%s.%s' % (

                                self.APP_NAME,

                                os.path.split(self.app_dir)[-1].replace('+', '-').replace('.', '-')))

# w.c.s. - web application for online forms

# Copyright (C) 2005-2012  Entr'ouvert

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, see <http://www.gnu.org/licenses/>.

#

#

# statsd.py - Python implementation of the statsd client

#

# Initially released (as License :: OSI Approved :: BSD License, from setup.py)

# by Steve Ivy <steveivy@gmail.com> - <https://github.com/sivy/py-statsd>

import random

import socket

import time

# Sends statistics to the stats daemon over UDP

class Client(object):

    def __init__(self, host='localhost', port=8125, prefix=None):

        """

        Create a new Statsd client.

        * host: the host where statsd is listening, defaults to localhost

        * port: the port where statsd is listening, defaults to 8125

        >>> from pystatsd import statsd

        >>> stats_client = statsd.Statsd(host, port)

        """

        self.addr = (socket.gethostbyname(host), port)

        self.prefix = prefix

        self.udp_sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)

    def timing_since(self, stat, start, sample_rate=1):

        """

        Log timing information as the number of microseconds since the provided time float

        >>> start = time.time()

        >>> # do stuff

        >>> statsd_client.timing_since('some.time', start)

        """

        self.timing(stat, int((time.time() - start) * 1000000), sample_rate)

    def timing(self, stat, time, sample_rate=1):

        """

        Log timing information for a single stat

        >>> statsd_client.timing('some.time',500)

        """

        stats = {stat: "%f|ms" % time}

        self.send(stats, sample_rate)

    def gauge(self, stat, value, sample_rate=1):

        """

        Log gauge information for a single stat

        >>> statsd_client.gauge('some.gauge',42)

        """

        stats = {stat: "%f|g" % value}

        self.send(stats, sample_rate)

    def increment(self, stats, sample_rate=1):

        """

        Increments one or more stats counters

        >>> statsd_client.increment('some.int')

        >>> statsd_client.increment('some.int',0.5)

        """

        self.update_stats(stats, 1, sample_rate=sample_rate)

    def decrement(self, stats, sample_rate=1):

        """

        Decrements one or more stats counters

        >>> statsd_client.decrement('some.int')

        """

        self.update_stats(stats, -1, sample_rate=sample_rate)

    def update_stats(self, stats, delta, sample_rate=1):

        """

        Updates one or more stats counters by arbitrary amounts

        >>> statsd_client.update_stats('some.int',10)

        """

        if not isinstance(stats, list):

            stats = [stats]

        data = dict((stat, "%s|c" % delta) for stat in stats)

        self.send(data, sample_rate)

    def send(self, data, sample_rate=1):

        """

        Squirt the metrics over UDP

        """

        if self.prefix:

            data = dict((".".join((self.prefix, stat)), value) for stat, value in data.iteritems())

        if sample_rate < 1:

            if random.random() > sample_rate:

                return

            sampled_data = dict((stat, "%s|@%s" % (value, sample_rate)) for stat, value in data.iteritems())

        else:

            sampled_data = data

        try:

            [self.udp_sock.sendto("%s:%s" % (stat, value), self.addr) for stat, value in sampled_data.iteritems()]

        except:

            pass

-