Skip to content

Commit e5ed867

Browse files
Tethikjsoriano
Tethik
authored and
jsoriano
committed
Add a HAProxy filebeat module. (#8014)
1 parent 980a90f commit e5ed867

19 files changed

Lines changed: 1203 additions & 1 deletion

‎filebeat/docs/fields.asciidoc‎

Lines changed: 352 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ grouped in the following categories:
1818
* <<exported-fields-cloud>>
1919
* <<exported-fields-docker-processor>>
2020
* <<exported-fields-elasticsearch>>
21+
* <<exported-fields-haproxy>>
2122
* <<exported-fields-host-processor>>
2223
* <<exported-fields-icinga>>
2324
* <<exported-fields-iis>>
@@ -1437,6 +1438,357 @@ Type
14371438
14381439
--
14391440
1441+
[[exported-fields-haproxy]]
1442+
== haproxy fields
1443+
1444+
haproxy Module
1445+
1446+
1447+
1448+
[float]
1449+
== haproxy fields
1450+
1451+
1452+
1453+
1454+
*`haproxy.process_name`*::
1455+
+
1456+
--
1457+
Name of the process
1458+
1459+
--
1460+
1461+
*`haproxy.pid`*::
1462+
+
1463+
--
1464+
type: long
1465+
1466+
Process ID
1467+
1468+
--
1469+
1470+
*`haproxy.client_ip`*::
1471+
+
1472+
--
1473+
client_ip is the IP address of the client which initiated the TCP connection to haproxy.
1474+
1475+
--
1476+
1477+
*`haproxy.client_port`*::
1478+
+
1479+
--
1480+
type: long
1481+
1482+
client_port is the TCP port of the client which initiated the connection.
1483+
1484+
--
1485+
1486+
*`haproxy.frontend_name`*::
1487+
+
1488+
--
1489+
frontend_name is the name of the frontend (or listener) which received and processed the connection.
1490+
1491+
--
1492+
1493+
*`haproxy.backend_name`*::
1494+
+
1495+
--
1496+
backend_name is the name of the backend (or listener) which was selected to manage the connection to the server.
1497+
1498+
--
1499+
1500+
*`haproxy.server_name`*::
1501+
+
1502+
--
1503+
server_name is the name of the last server to which the connection was sent.
1504+
1505+
--
1506+
1507+
*`haproxy.time_client_req`*::
1508+
+
1509+
--
1510+
type: long
1511+
1512+
time_client_req is the total time in milliseconds spent waiting for a full HTTP request from the client (not counting body) after the first byte was received.
1513+
1514+
--
1515+
1516+
*`haproxy.time_queue`*::
1517+
+
1518+
--
1519+
type: long
1520+
1521+
time_queue is the total time in milliseconds spent waiting in the various queues.
1522+
1523+
--
1524+
1525+
*`haproxy.time_backend_connect`*::
1526+
+
1527+
--
1528+
type: long
1529+
1530+
time_backend_connect is the total time in milliseconds spent waiting for the connection to establish to the final server, including retries.
1531+
1532+
--
1533+
1534+
*`haproxy.time_server_response`*::
1535+
+
1536+
--
1537+
type: long
1538+
1539+
time_server_response is the total time in milliseconds spent waiting for the server to send a full HTTP response, not counting data.
1540+
1541+
--
1542+
1543+
*`haproxy.time_duration`*::
1544+
+
1545+
--
1546+
type: long
1547+
1548+
time_duration is the time the request remained active in haproxy, which is the total time in milliseconds elapsed between the first byte of the request was received and the last byte of response was sent.
1549+
1550+
--
1551+
1552+
*`haproxy.server_queue`*::
1553+
+
1554+
--
1555+
type: long
1556+
1557+
server_queue is the total number of requests which were processed before this one in the server queue.
1558+
1559+
--
1560+
1561+
*`haproxy.backend_queue`*::
1562+
+
1563+
--
1564+
type: long
1565+
1566+
backend_queue is the total number of requests which were processed before this one in the backend's global queue.
1567+
1568+
--
1569+
1570+
*`haproxy.bind_name`*::
1571+
+
1572+
--
1573+
1574+
1575+
--
1576+
1577+
*`haproxy.error_message`*::
1578+
+
1579+
--
1580+
type: text
1581+
1582+
error_message is the error message logged by HAProxy in case of error.
1583+
1584+
--
1585+
1586+
[float]
1587+
== geoip fields
1588+
1589+
Contains GeoIP information gathered based on the client_ip field. Only present if the GeoIP Elasticsearch plugin is available and used.
1590+
1591+
1592+
1593+
*`haproxy.geoip.continent_name`*::
1594+
+
1595+
--
1596+
type: keyword
1597+
1598+
The name of the continent.
1599+
1600+
1601+
--
1602+
1603+
*`haproxy.geoip.country_iso_code`*::
1604+
+
1605+
--
1606+
type: keyword
1607+
1608+
Country ISO code.
1609+
1610+
1611+
--
1612+
1613+
*`haproxy.geoip.location`*::
1614+
+
1615+
--
1616+
type: geo_point
1617+
1618+
The longitude and latitude.
1619+
1620+
1621+
--
1622+
1623+
*`haproxy.geoip.region_name`*::
1624+
+
1625+
--
1626+
type: keyword
1627+
1628+
The region name.
1629+
1630+
1631+
--
1632+
1633+
*`haproxy.geoip.city_name`*::
1634+
+
1635+
--
1636+
type: keyword
1637+
1638+
The city name.
1639+
1640+
1641+
--
1642+
1643+
*`haproxy.geoip.region_iso_code`*::
1644+
+
1645+
--
1646+
type: keyword
1647+
1648+
Region ISO code.
1649+
1650+
1651+
--
1652+
1653+
*`haproxy.termination_state`*::
1654+
+
1655+
--
1656+
termination_state is the condition the session was in when the session ended.
1657+
1658+
--
1659+
1660+
[float]
1661+
== connections fields
1662+
1663+
Contains various counts of connections active in the process.
1664+
1665+
1666+
*`haproxy.connections.active`*::
1667+
+
1668+
--
1669+
type: long
1670+
1671+
active is the total number of concurrent connections on the process when the session was logged.
1672+
1673+
--
1674+
1675+
*`haproxy.connections.frontend`*::
1676+
+
1677+
--
1678+
type: long
1679+
1680+
frontend is the total number of concurrent connections on the frontend when the session was logged.
1681+
1682+
--
1683+
1684+
*`haproxy.connections.backend`*::
1685+
+
1686+
--
1687+
type: long
1688+
1689+
backend is the total number of concurrent connections handled by the backend when the session was logged.
1690+
1691+
--
1692+
1693+
*`haproxy.connections.server`*::
1694+
+
1695+
--
1696+
type: long
1697+
1698+
server is the total number of concurrent connections still active on the server when the session was logged.
1699+
1700+
--
1701+
1702+
*`haproxy.connections.retries`*::
1703+
+
1704+
--
1705+
type: long
1706+
1707+
retries is the number of connection retries experienced by this session when trying to connect to the server.
1708+
1709+
--
1710+
1711+
[float]
1712+
== http fields
1713+
1714+
Please add description
1715+
1716+
1717+
[float]
1718+
== response fields
1719+
1720+
Fields related to the HTTP response
1721+
1722+
1723+
*`haproxy.http.response.status_code`*::
1724+
+
1725+
--
1726+
type: long
1727+
1728+
status_code is the HTTP status code returned to the client.
1729+
1730+
--
1731+
1732+
*`haproxy.http.response.bytes_read`*::
1733+
+
1734+
--
1735+
type: long
1736+
1737+
bytes_read is the total number of bytes transmitted to the client when the log is emitted.
1738+
1739+
--
1740+
1741+
*`haproxy.http.response.captured_cookie`*::
1742+
+
1743+
--
1744+
captured_cookie is an optional "name=value" entry indicating that the client had this cookie in the response.
1745+
1746+
1747+
--
1748+
1749+
*`haproxy.http.response.captured_headers`*::
1750+
+
1751+
--
1752+
type: text
1753+
1754+
captured_response_headers is a list of headers captured in the response due to the presence of the "capture response header" statement in the frontend.
1755+
1756+
1757+
--
1758+
1759+
[float]
1760+
== request fields
1761+
1762+
Fields related to the HTTP request
1763+
1764+
1765+
*`haproxy.http.request.captured_cookie`*::
1766+
+
1767+
--
1768+
captured_cookie is an optional "name=value" entry indicating that the server has returned a cookie with its request.
1769+
1770+
1771+
--
1772+
1773+
*`haproxy.http.request.captured_headers`*::
1774+
+
1775+
--
1776+
type: text
1777+
1778+
captured_request_headers is a list of headers captured in the request due to the presence of the "capture request header" statement in the frontend.
1779+
1780+
1781+
--
1782+
1783+
*`haproxy.http.request.raw_request_line`*::
1784+
+
1785+
--
1786+
type: text
1787+
1788+
raw_request_line is the complete HTTP request line, including the method, request and HTTP version string.
1789+
1790+
--
1791+
14401792
[[exported-fields-host-processor]]
14411793
== Host fields
14421794

‎filebeat/docs/images/kibana-haproxy-overview.png‎

176 KB
Loading

0 commit comments

Comments
 (0)