Puppet Class: webperf::navtiming

Defined in:
modules/webperf/manifests/navtiming.pp

Overview

SPDX-License-Identifier: Apache-2.0

Class: webperf::navtiming

Captures NavigationTiming events from Kafka and send them to StatsD / Graphite. See meta.wikimedia.org/wiki/Schema:NavigationTiming & www.mediawiki.org/wiki/Extension:NavigationTiming

Parameters

kafka_brokers

String of comma separated Kafka bootstrap brokers.

kafka_security_protocol

one of “PLAINTEXT”, “SSL”, “SASL”, “SASL_SSL”

statsd_host

Write stats to this StatsD instance. Default: '127.0.0.1'.

statsd_port

Write stats to this StatsD instance. Default: 8125.

Parameters:

  • kafka_brokers (String)
  • kafka_security_protocol (Optional[String]) (defaults to: 'PLAINTEXT')
  • statsd_host (Stdlib::Host) (defaults to: '127.0.0.1')
  • statsd_port (Stdlib::Port) (defaults to: 8125)
  • kafka_ssl_cafile (Optional[Stdlib::Unixpath]) (defaults to: undef)


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
# File 'modules/webperf/manifests/navtiming.pp', line 22

class webperf::navtiming(
    String                     $kafka_brokers,
    Optional[String]           $kafka_security_protocol = 'PLAINTEXT',
    Stdlib::Host               $statsd_host             = '127.0.0.1',
    Stdlib::Port               $statsd_port             = 8125,
    Optional[Stdlib::Unixpath] $kafka_ssl_cafile        = undef,
) {
    include ::webperf

    ensure_packages(['python3-kafka', 'python3-yaml', 'python3-etcd', 'python3-snappy'])

    # This matches the version pinned in setup.py in performance/navtiming.
    # If changed here, it should be changed there, and vice-versa.
    # (See comments on https://gerrit.wikimedia.org/r/c/performance/navtiming/+/622531)
    apt::pin { 'python3-ua-parser':
        pin      => 'version 0.10.0*',
        package  => 'python3-ua-parser',
        priority => 1001,
        before   => Package['python3-ua-parser'],
    }
    package { 'python3-ua-parser':
        ensure => present,
    }

    scap::target { 'performance/navtiming':
        service_name => 'navtiming',
        deploy_user  => 'deploy-service',
    }

    systemd::service { 'navtiming':
        # uses $statsd_host, $statsd_port, $kafka_brokers,
        # $kafka_security_protocol, and $kafka_ssl_cafile
        content => template('webperf/navtiming.systemd.erb'),
        restart => true,
    }

    profile::auto_restarts::service { 'navtiming': }
}