File: frontend.rst

package info (click to toggle)
python-haproxyadmin 0.2.4-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 436 kB
  • sloc: python: 1,500; makefile: 165; sh: 1
file content (167 lines) | stat: -rw-r--r-- 3,779 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
.. _frontend:

Frontend Operations
-------------------

A quick way to check if a certain frontend exists

.. code:: python

    >>> frontends = hap.frontends()
    >>> if 'frontend2_proc34' in frontends:
    ...    print('have it')
    ...
    have it
    >>> if 'frontend2_proc34foo' in frontends:
    ...    print('have it')
    ...
    >>>

Change maximum connections to all frontends

.. code:: python

    >>> frontends = hap.frontends()
    >>> for f in frontends:
    ...    print(f.maxconn, f.name)
    ...    f.setmaxconn(10000)
    ...    print(f.maxconn, f.name)
    ...    print('---------------')
    ...
    3000 haproxy-stats2
    True
    10000 haproxy-stats2
    ---------------
    6000 frontend1_proc34
    True
    20000 frontend1_proc34
    ---------------
    6000 frontend2_proc34
    True
    20000 frontend2_proc34
    ---------------
    3000 frontend_proc2
    True
    10000 frontend_proc2
    ---------------
    3000 haproxy-stats
    True
    10000 haproxy-stats
    ---------------
    3000 haproxy-stats3
    True
    10000 haproxy-stats3
    ---------------
    3000 haproxy-stats4
    True
    10000 haproxy-stats4
    ---------------
    3000 frontend_proc1
    True
    10000 frontend_proc1
    ---------------

Do the same only on specific frontend

.. code:: python

    >>> frontend = hap.frontend('frontend1_proc34')
    >>> frontend.maxconn
    20000
    >>> frontend.setmaxconn(50000)
    True
    >>> frontend.maxconn
    100000


Disable and enable a frontend

.. code:: python

    >>> frontend = hap.frontend('frontend1_proc34')
    >>> frontend.status
    'OPEN'
    >>> frontend.disable()
    True
    >>> frontend.status
    'STOP'
    >>> frontend.enable()
    True
    >>> frontend.status
    'OPEN'

Shutdown a frontend

.. code:: python

    >>> frontend.shutdown()
    True

.. warning::
    HAProxy removes from the running configuration the frontend, so
    further operations on the frontend will return an error.

.. code:: python

    >>> frontend.status
    Traceback (most recent call last):
    File "<stdin>", line 1, in <module>
    File "/..ages/haproxyadmin/frontend.py", line 243, in status
        'status')
    File "/...ages/haproxyadmin/utils.py", line 168, in cmd_across_all_procs
        (getattr(obj, 'process_nb'), getattr(obj, method)(*arg))
    File "/...ages/haproxyadmin/internal.py", line 210, in metric
        getattr(self.hap_process.frontends_stats()[self.name], name))
    KeyError: 'frontend1_proc34'


Retrieve various statistics

.. code:: python

    >>> frontend = hap.frontend('frontend2_proc34')
    >>> for m in FRONTEND_METRICS:
    ...    print("name {} value {}".format(m, frontend.metric(m)))
    ...
    name bin value 380
    name bout value 1065
    name comp_byp value 0
    name comp_in value 0
    name comp_out value 0
    name comp_rsp value 0
    name dreq value 0
    name dresp value 0
    name ereq value 0
    name hrsp_1xx value 0
    name hrsp_2xx value 0
    name hrsp_3xx value 0
    name hrsp_4xx value 0
    name hrsp_5xx value 5
    name hrsp_other value 0
    name rate value 0
    name rate_lim value 200000
    name rate_max value 2
    name req_rate value 0
    name req_rate_max value 2
    name req_tot value 5
    name scur value 0
    name slim value 20000
    name smax value 3
    name stot value 5
    >>>
    >>> frontend.process_nb
    [4, 3]
    >>> frontend.requests_per_process()
    [(4, 2), (3, 3)]
    >>> frontend.requests
    5
    >>>


.. note::
    ``requests`` returns HTTP requests that are processed by the frontend.
    If the frontend is in TCP mode the number will be always 0 and *stot*
    metric should be used to retrieve the number of TCP requests processsed.


Read :class:`Frontend <.Frontend>` class for more information.