ScuroNeko/mtg
1
0
Fork 0
mirror of https://github.com/ScuroNeko/mtg.git synced 2026-08-31 18:24:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add docs for stats

Browse Source
This commit is contained in:
9seconds
2021-04-06 12:00:14 +03:00
parent 54a7c6a2a5
commit b748603096
4 changed files with 109 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
stats/init.go
+83 -8
View File
@@ -1,31 +1,106 @@
// Stats package has implementations of events.Observers for different
// monitoring systems.
//
// Observer is a consumer of events produced by mtg. Consumers, defined
// in this package, process these events and provide information used by
// different monitoring system or time series databases.
package stats
const (
// DefaultMetricPrefix defines a base prefix for all metrics.
DefaultMetricPrefix = "mtg"
// DefaultStatsdMetricPrefix defines a base prefix for metrics
// which are passed to statsd.
DefaultStatsdMetricPrefix = DefaultMetricPrefix + "."
DefaultStatsdTagFormat = "datadog"
MetricClientConnections = "client_connections"
MetricTelegramConnections = "telegram_connections"
// DefaultStatsdTagFormat defines a format of tags for statsd
// observer.
DefaultStatsdTagFormat = "datadog"
// MetricClientConnections defines a metric which is responsible for a
// number of currently active connections established by client.
//
// Type: gauge
// Tags:
// ip_family | A type of ip (ipv4 or ipv6) of the client.
MetricClientConnections = "client_connections"
// MetricTelegramConnections defines a metric which is responsible for
// a count of active connections to Telegram servers.
//
// Type: gauge
// Tags:
// telegram_ip | IP address of the telegram server.
// dc | Index of the datacenter to connect to.
MetricTelegramConnections = "telegram_connections"
// MetricDomainFrontingConnections defines a metric which is
// responsible for a count of active connections to a fronting domain.
// Fronting domain is that one that is encoded in a secret.
//
// Type: gauge
// Tags:
// ip_family | A type of IP (ipv4 or ipv6) that was used.
MetricDomainFrontingConnections = "domain_fronting_connections"
MetricTelegramTraffic = "telegram_traffic"
// MetricTelegramTraffic defines a metric for traffic (in bytes) that
// is sent to and from Telegram servers.
//
// Type: counter
// Tags:
// telegram_ip | IP address of the telegram server.
// dc | Index of the datacenter
// direction | Direction of the traffc flow. Values are
// | 'to_client' and 'from_client'
MetricTelegramTraffic = "telegram_traffic"
// MetricDomainFrontingTraffic defines a metric for traffic (in bytes)
// that is sent to and from fronting domain.
//
// Type: counter
// Tags:
// direction | Direction of the traffc flow. Values are
// | 'to_client' and 'from_client'
MetricDomainFrontingTraffic = "domain_fronting_traffic"
MetricDomainFronting = "domain_fronting"
MetricConcurrencyLimited = "concurrency_limited"
MetricIPBlocklisted = "ip_blocklisted"
MetricReplayAttacks = "replay_attacks"
// MetricDomainFronting defines a metric for a number of domain
// fronting routing events.
//
// Type: counter
MetricDomainFronting = "domain_fronting"
// MetricConcurrencyLimited defines a metric for a count of events,
// when the client was blocked due to the concurrency limit.
//
// Type: counter
MetricConcurrencyLimited = "concurrency_limited"
// MetricIPBlocklisted defines a metric for a count of events, when
// client was blocked because her IP address was found in blocklists.
//
// Type: counter
MetricIPBlocklisted = "ip_blocklisted"
// MetricReplayAttacks defines a metric for a count of events, when
// mtg has detected a replay attack. Just a reminder: mtg immediately
// routes a connection to a fronting domain if such event is detected.
//
// Type: counter
MetricReplayAttacks = "replay_attacks"
// TagIPFamily defines a name of the 'ip_family' tag and all values.
TagIPFamily = "ip_family"
TagIPFamilyIPv4 = "ipv4"
TagIPFamilyIPv6 = "ipv6"
// TagTelegramIP defines a name of the 'telegram_ip' tag.
TagTelegramIP = "telegram_ip"
// TagDC defines a name of the 'dc' tag.
TagDC = "dc"
// TagDirection defines a name of the 'direction' tag.
TagDirection = "direction"
TagDirectionToClient = "to_client"
TagDirectionFromClient = "from_client"