diff --git a/cmds/portmaster-core/main.go b/cmds/portmaster-core/main.go index ef6781bb..45a10ab6 100644 --- a/cmds/portmaster-core/main.go +++ b/cmds/portmaster-core/main.go @@ -4,6 +4,7 @@ import ( "os" "github.com/safing/portbase/info" + "github.com/safing/portbase/metrics" "github.com/safing/portbase/run" "github.com/safing/spn/conf" @@ -20,6 +21,9 @@ func main() { // set information info.Set("Portmaster", "0.6.4", "AGPLv3", true) + // Configure metrics. + metrics.SetNamespace("portmaster") + // enable SPN client mode conf.EnableClient(true) diff --git a/core/base/module.go b/core/base/module.go index 4c548936..759d5d8e 100644 --- a/core/base/module.go +++ b/core/base/module.go @@ -1,10 +1,13 @@ package base import ( + "github.com/safing/portbase/log" + "github.com/safing/portbase/metrics" "github.com/safing/portbase/modules" // module dependencies _ "github.com/safing/portbase/config" + _ "github.com/safing/portbase/metrics" _ "github.com/safing/portbase/rng" ) @@ -13,7 +16,7 @@ var ( ) func init() { - module = modules.Register("base", nil, start, nil, "database", "config", "rng") + module = modules.Register("base", nil, start, nil, "database", "config", "rng", "metrics") // For prettier subsystem graph, printed with --print-subsystem-graph /* @@ -31,5 +34,14 @@ func init() { func start() error { startProfiling() - return registerDatabases() + if err := registerDatabases(); err != nil { + return err + } + + // Set metrics storage key and load them from db. + if err := metrics.EnableMetricPersistence("core:metrics/storage"); err != nil { + log.Warningf("core: failed to load persisted metrics from db: %s", err) + } + + return nil } diff --git a/firewall/interception.go b/firewall/interception.go index d3a7a168..79ae0b4d 100644 --- a/firewall/interception.go +++ b/firewall/interception.go @@ -50,7 +50,12 @@ func init() { network.SetDefaultFirewallHandler(defaultHandler) } -func interceptionPrep() (err error) { +func interceptionPrep() error { + err := registerMetrics() + if err != nil { + return err + } + return prepAPIAuth() } @@ -81,6 +86,10 @@ func SetNameserverIPMatcher(fn func(ip net.IP) bool) error { } func handlePacket(ctx context.Context, pkt packet.Packet) { + // Record metrics. + startTime := time.Now() + defer packetHandlingHistogram.UpdateDuration(startTime) + if fastTrackedPermit(pkt) { return } diff --git a/firewall/metrics.go b/firewall/metrics.go new file mode 100644 index 00000000..30d56b4b --- /dev/null +++ b/firewall/metrics.go @@ -0,0 +1,21 @@ +package firewall + +import ( + "github.com/safing/portbase/api" + "github.com/safing/portbase/config" + "github.com/safing/portbase/metrics" +) + +var packetHandlingHistogram *metrics.Histogram + +func registerMetrics() (err error) { + packetHandlingHistogram, err = metrics.NewHistogram( + "firewall/handling/duration/seconds", + nil, + &metrics.Options{ + Permission: api.PermitUser, + ExpertiseLevel: config.ExpertiseLevelExpert, + }) + + return err +} diff --git a/go.mod b/go.mod index 976ad82b..a4ec7109 100644 --- a/go.mod +++ b/go.mod @@ -13,7 +13,6 @@ require ( github.com/godbus/dbus/v5 v5.0.3 github.com/gofrs/uuid v4.0.0+incompatible // indirect github.com/google/gopacket v1.1.18 - github.com/google/renameio v1.0.0 github.com/gorilla/mux v1.8.0 // indirect github.com/hashicorp/go-multierror v1.1.0 github.com/hashicorp/go-version v1.2.1 @@ -44,3 +43,10 @@ require ( golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776 // indirect ) + +require ( + // The follow-up commit removes Windows support. + // TOOD: Check how we want to handle this in the future, possibly ingest + // needed functionality into here. + github.com/google/renameio v0.1.1-0.20200217212219-353f81969824 +) diff --git a/go.sum b/go.sum index 3de33b8d..f3511dd4 100644 --- a/go.sum +++ b/go.sum @@ -1,29 +1,38 @@ cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= github.com/AndreasBriese/bbloom v0.0.0-20190306092124-e2d15f34fcf9/go.mod h1:bOvUY6CB00SOBii9/FifXqc0awNKxLFCL/+pkDPuyl8= +github.com/AndreasBriese/bbloom v0.0.0-20190825152654-46b345b51c96 h1:cTp8I5+VIoKjsnZuH8vjyaysT/ses3EvZeaV/1UkF2M= github.com/AndreasBriese/bbloom v0.0.0-20190825152654-46b345b51c96/go.mod h1:bOvUY6CB00SOBii9/FifXqc0awNKxLFCL/+pkDPuyl8= github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= github.com/OneOfOne/xxhash v1.2.2 h1:KMrpdQIwFcEqXDklaen+P1axHaj9BSKzvpUUfnHldSE= github.com/OneOfOne/xxhash v1.2.2/go.mod h1:HSdplMjZKSmBqAxg5vPj2TmRDmfkzw+cTzAElWljhcU= +github.com/StackExchange/wmi v0.0.0-20190523213315-cbe66965904d h1:G0m3OIz70MZUWq3EgK3CesDbo8upS2Vm9/P3FtgI+Jk= github.com/StackExchange/wmi v0.0.0-20190523213315-cbe66965904d/go.mod h1:3eOhrUMpNV+6aFIbp5/iudMxNCF27Vw2OZgy4xEx0Fg= +github.com/aead/ecdh v0.2.0 h1:pYop54xVaq/CEREFEcukHRZfTdjiWvYIsZDXXrBapQQ= github.com/aead/ecdh v0.2.0/go.mod h1:a9HHtXuSo8J1Js1MwLQx2mBhkXMT6YwUmVVEY4tTB8U= +github.com/aead/serpent v0.0.0-20160714141033-fba169763ea6 h1:5L8Mj9Co9sJVgW3TpYk2gxGJnDjsYuboNTcRmbtGKGs= github.com/aead/serpent v0.0.0-20160714141033-fba169763ea6/go.mod h1:3HgLJ9d18kXMLQlJvIY3+FszZYMxCz8WfE2MQ7hDY0w= +github.com/agext/levenshtein v1.2.3 h1:YB2fHEn0UJagG8T1rrWknE3ZQzWM06O8AMAatNn7lmo= github.com/agext/levenshtein v1.2.3/go.mod h1:JEDfjyjHDjOF/1e4FlBE/PkbqA9OfWu2ki2W0IB5558= github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8= +github.com/armon/go-radix v1.0.0 h1:F4z6KzEeeQIMeLFa97iZU6vupzoecKdU5TX24SNppXI= github.com/armon/go-radix v1.0.0/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8= github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q= github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8= +github.com/bluele/gcache v0.0.0-20190518031135-bc40bd653833 h1:yCfXxYaelOyqnia8F/Yng47qhmfC9nKTRIbYRrRueq4= github.com/bluele/gcache v0.0.0-20190518031135-bc40bd653833/go.mod h1:8c4/i2VlovMO2gBnHGQPN5EJw+H0lx1u/5p+cgsXtCk= github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU= github.com/cespare/xxhash v1.1.0 h1:a6HrQnmkObjyL+Gs60czilIUGqrzKutQD6XZog3p+ko= github.com/cespare/xxhash v1.1.0/go.mod h1:XrSqR1VqqWfGrhpAt58auRo0WTKS1nRRg3ghfAqPWnc= github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw= github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc= +github.com/cookieo9/resources-go v0.0.0-20150225115733-d27c04069d0d h1:O+gcIbHv8EocDRI8swPGYI6XPJDbdZ66jeXqfoXifLE= github.com/cookieo9/resources-go v0.0.0-20150225115733-d27c04069d0d/go.mod h1:Da90oEbCMTyeoWRBoWQHAmajIlLPjji2U2w7HJGAnuY= github.com/coreos/bbolt v1.3.2/go.mod h1:iRUV2dpdMOn7Bo10OQBFzIJO9kkE559Wcmn+qkEiiKk= github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE= github.com/coreos/go-etcd v2.0.0+incompatible/go.mod h1:Jez6KQU2B/sWsbdaef3ED8NzMklzPG4d5KIOhIy30Tk= +github.com/coreos/go-iptables v0.4.5 h1:DpHb9vJrZQEFMcVLFKAAGMUVX0XoRC0ptCthinRYm38= github.com/coreos/go-iptables v0.4.5/go.mod h1:/mVI274lEDI2ns62jHCDnCyBF9Iwsmekav8Dbxlm1MU= github.com/coreos/go-semver v0.2.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk= github.com/coreos/go-systemd v0.0.0-20190321100706-95778dfbb74e/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4= @@ -36,10 +45,13 @@ github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSs github.com/dgraph-io/badger v1.6.1/go.mod h1:FRmFw3uxvcpa8zG3Rxs0th+hCLIuaQg8HlNV5bjgnuU= github.com/dgraph-io/badger v1.6.2 h1:mNw0qs90GVgGGWylh0umH5iag1j6n/PeJtNvL6KY/x8= github.com/dgraph-io/badger v1.6.2/go.mod h1:JW2yswe3V058sS0kZ2h/AXeDSqFjxnZcRrVH//y2UQE= +github.com/dgraph-io/ristretto v0.0.2 h1:a5WaUrDa0qm0YrAAS1tUykT5El3kt62KNZZeMxQn3po= github.com/dgraph-io/ristretto v0.0.2/go.mod h1:KPxhHT9ZxKefz+PCeOGsrHpl1qZ7i70dGTu2u+Ahh6E= github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ= +github.com/dgryski/go-farm v0.0.0-20190423205320-6a90982ecee2 h1:tdlZCpZ/P9DhczCTSixgIKmwPv6+wP5DGjqLYw5SUiA= github.com/dgryski/go-farm v0.0.0-20190423205320-6a90982ecee2/go.mod h1:SqUrOPUnsFjfmXRMNPybcSiG0BgUW2AuFH8PAnS2iTw= github.com/dgryski/go-sip13 v0.0.0-20181026042036-e10d5fee7954/go.mod h1:vAd38F8PWV+bWy6jNmig1y/TA+kYO4g3RSRF0IAv0no= +github.com/dustin/go-humanize v1.0.0 h1:VSnTsYCnlFHaM2/igO1h6X3HA71jcobQuxemgkq4zYo= github.com/dustin/go-humanize v1.0.0/go.mod h1:HtrtbFcZ19U5GC7JDqmcUSB87Iq5E25KnS6fMYU6eOk= github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98= @@ -55,6 +67,7 @@ github.com/go-ole/go-ole v1.2.4/go.mod h1:XCwSNxSkXRo4vlyPy93sltvi/qJq0jqQhjqQNI github.com/go-ole/go-ole v1.2.5 h1:t4MGB5xEDZvXI+0rMjjsfBsD7yAgp/s9ZDkL1JndXwY= github.com/go-ole/go-ole v1.2.5/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiUsvbm0= github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY= +github.com/godbus/dbus/v5 v5.0.3 h1:ZqHaoEF7TBzh4jzPmqVhE/5A1z9of6orkAe5uHoAeME= github.com/godbus/dbus/v5 v5.0.3/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= github.com/gofrs/uuid v3.3.0+incompatible/go.mod h1:b2aQJv3Z4Fp6yNu3cdSllBxTCLRxnplIgP/c0N/04lM= github.com/gofrs/uuid v4.0.0+incompatible h1:1SD/1F5pU8p29ybwgQSwpQk+mwdRrXCYuPhW6m+TnJw= @@ -73,6 +86,7 @@ github.com/golang/protobuf v1.4.0-rc.1.0.20200221234624-67d41d38c208/go.mod h1:x github.com/golang/protobuf v1.4.0-rc.2/go.mod h1:LlEzMj4AhA7rCAGe4KMBDvJI+AwstrUpVNzEA03Pprs= github.com/golang/protobuf v1.4.0-rc.4.0.20200313231945-b860323f09d0/go.mod h1:WU3c8KckQ9AFe+yFwt9sWVRKCVIyN9cPHBJSNnbL67w= github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvqG2KuDX0= +github.com/golang/protobuf v1.4.2 h1:+Z5KGCizgyZCbGh1KZqA0fcLLkwbsjIzS4aV2v7wJX0= github.com/golang/protobuf v1.4.2/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= @@ -86,6 +100,8 @@ github.com/google/gopacket v1.1.18 h1:lum7VRA9kdlvBi7/v2p7/zcbkduHaCH/SVVyurs7Op github.com/google/gopacket v1.1.18/go.mod h1:UdDNZ1OO62aGYVnPhxT1U6aI7ukYtA/kB8vaU0diBUM= github.com/google/renameio v0.1.0 h1:GOZbcHa3HfsPKPlmyPyN2KEohoMXOhdMbHrvbpl2QaA= github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI= +github.com/google/renameio v0.1.1-0.20200217212219-353f81969824 h1:9q700G0beHecUuiZOuKgNqNsGQixTeDLnzVZ5nsW3lc= +github.com/google/renameio v0.1.1-0.20200217212219-353f81969824/go.mod h1:t/HQoYBZSsWSNK35C6CO/TpPLDVWvxOHboWUAweKUpk= github.com/google/renameio v1.0.0 h1:xhp2CnJmgQmpJU4RY8chagahUq5mbPPAbiSQstKpVMA= github.com/google/renameio v1.0.0/go.mod h1:t/HQoYBZSsWSNK35C6CO/TpPLDVWvxOHboWUAweKUpk= github.com/gorilla/mux v1.7.4/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So= @@ -104,6 +120,7 @@ github.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brv github.com/hashicorp/go-multierror v1.1.0 h1:B9UzwGQJehnUY1yNrnwREHc3fGbC2xefo8g4TbElacI= github.com/hashicorp/go-multierror v1.1.0/go.mod h1:spPvp8C1qA32ftKqdAHm4hHTbPw+vmowP0z+KUhOZdA= github.com/hashicorp/go-version v1.2.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= +github.com/hashicorp/go-version v1.2.1 h1:zEfKbn2+PDgroKdiOzqiE8rsmLqU2uwi5PB5pBJ3TkI= github.com/hashicorp/go-version v1.2.1/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ= github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM= @@ -115,6 +132,7 @@ github.com/jsimonetti/rtnetlink v0.0.0-20201009170750-9c6f07d100c1/go.mod h1:hqo github.com/jsimonetti/rtnetlink v0.0.0-20201216134343-bde56ed16391 h1:Dqu/4JhMV1vpXHDjzQCuDCEsjNi0xfuSmQlMOyqayKA= github.com/jsimonetti/rtnetlink v0.0.0-20201216134343-bde56ed16391/go.mod h1:cR77jAZG3Y3bsb8hF6fHJbFoyFukLFOkQ98S0pQz3xw= github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7VTCxuUUipMqKk8s4w= +github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0 h1:iQTw/8FWTuc7uiaSepXwyf3o52HaUYcV+Tu66S3F5GA= github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0/go.mod h1:1NbS8ALrpOvjt0rHPNLyCIeMtbizbir8U//inJ+zuB8= github.com/kisielk/errcheck v1.1.0/go.mod h1:EZBBE59ingxPouuu3KfxchcWSUPOHkagtvWXihfKN4Q= github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= @@ -144,6 +162,7 @@ github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrk github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y= github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U= +github.com/oschwald/maxminddb-golang v1.7.0 h1:JmU4Q1WBv5Q+2KZy5xJI+98aUwTIrPPxZUkd5Cwr8Zc= github.com/oschwald/maxminddb-golang v1.7.0/go.mod h1:RXZtst0N6+FY/3qCNmZMBApR19cdQj43/NM9VkrNAis= github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic= github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= @@ -169,10 +188,14 @@ github.com/safing/jess v0.2.1 h1:35eYqM+JnN16NuepQzk5cyONbU2Dka6v+y1tyRL7Yj0= github.com/safing/jess v0.2.1/go.mod h1:IRjuFYOID7jWBntY4YBDEe+orvm3ptIk/gm5jMsiW0U= github.com/safing/portbase v0.9.3-0.20210119093951-79ec7e573a3e h1:tElxDAdKOOrk3soU5sEScHUU4dQGQ5mVvI0DyUyF9NU= github.com/safing/portbase v0.9.3-0.20210119093951-79ec7e573a3e/go.mod h1:xktwV7O+CNGjg9ULlFj72M/zM+R5YceTrHdbpGsTmj0= +github.com/safing/portbase v0.9.3 h1:x50rfNuEpilEE7qWtLmjPLvTInSyJWYYLOHSuqvbgkY= github.com/safing/spn v0.2.4 h1:V2XPMTQkHo7xwH89Kfx+65cFWgXAz/jCeCXcweEJuLQ= github.com/safing/spn v0.2.4/go.mod h1:ZA6za4rEP46GiVKJGZsQyqoqMvPhtF913mg5JtJl3Sc= +github.com/satori/go.uuid v1.2.0 h1:0uYX9dsZ2yD7q2RtLRtPSdGDWzjeM3TbMJP9utgA0ww= github.com/satori/go.uuid v1.2.0/go.mod h1:dA0hQrYB0VpLJoorglMZABFdXlWrHn1NEOzdhQKdks0= +github.com/seehuhn/fortuna v1.0.1 h1:lu9+CHsmR0bZnx5Ay646XvCSRJ8PJTi5UYJwDBX68H0= github.com/seehuhn/fortuna v1.0.1/go.mod h1:LX8ubejCnUoT/hX+1aKUtbKls2H6DRkqzkc7TdR3iis= +github.com/seehuhn/sha256d v1.0.0 h1:TXTsAuEWr02QjRm153Fnvvb6fXXDo7Bmy1FizxarGYw= github.com/seehuhn/sha256d v1.0.0/go.mod h1:PEuxg9faClSveVuFXacQmi+NtDI/PX8bpKjtNzf2+s4= github.com/shirou/gopsutil v2.20.4+incompatible/go.mod h1:5b4v6he4MtMOwMlS0TUMTu2PcXUg8+E1lC7eC3UO/RA= github.com/shirou/gopsutil v3.20.12+incompatible h1:6VEGkOXP/eP4o2Ilk8cSsX0PhOEfX6leqAnD+urrp9M= @@ -181,10 +204,12 @@ github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeV github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo= github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4kGIyLM= github.com/spaolacci/murmur3 v0.0.0-20180118202830-f09979ecbc72/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA= +github.com/spaolacci/murmur3 v1.1.0 h1:7c1g84S4BPRrfL5Xrdp6fOJ206sU9y293DDHaoy0bLI= github.com/spaolacci/murmur3 v1.1.0/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA= github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ= github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE= github.com/spf13/cobra v0.0.5/go.mod h1:3K3wKZymM7VvHMDS9+Akkh4K60UwM26emMESw8tLCHU= +github.com/spf13/cobra v1.0.0 h1:6m/oheQuQ13N9ks4hubMG6BnvwOeaJrqSPLahSnczz8= github.com/spf13/cobra v1.0.0/go.mod h1:/6GTrnGXV9HjY+aR4k0oJ5tcvakLuG6EuKReYlHNrgE= github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb68N+wFjFa4jdeBTo= github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= @@ -225,6 +250,7 @@ github.com/tjfoc/gmsm v1.4.0/go.mod h1:j4INPkHWMrhJb38G+J6W4Tw0AbuN8Thu3PbdVYhVc github.com/tmc/grpc-websocket-proxy v0.0.0-20190109142713-0ad062ec5ee5/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U= github.com/ugorji/go v1.1.4/go.mod h1:uQMGLiO92mf5W77hV/PUCpI3pbzQx3CRekS0kk+RGrc= github.com/ugorji/go/codec v0.0.0-20181204163529-d75b2dcb6bc8/go.mod h1:VFNgLljTbGfSG7qAOspJ7OScBnGdDN/yBr0sguwnwf0= +github.com/umahmood/haversine v0.0.0-20151105152445-808ab04add26 h1:UFHFmFfixpmfRBcxuu+LA9l8MdURWVdVNUHxO5n1d2w= github.com/umahmood/haversine v0.0.0-20151105152445-808ab04add26/go.mod h1:IGhd0qMDsUa9acVjsbsT7bu3ktadtGOHI79+idTew/M= github.com/xiang90/probing v0.0.0-20190116061207-43a291ad63a2/go.mod h1:UETIi67q53MR2AWcXfiuqkDkRtnGDLqkBTpCHuJHxtU= github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77/go.mod h1:aYKd//L2LvnjZzWKhF00oedf4jCCReLcmhLdhm1A27Q= @@ -234,6 +260,7 @@ github.com/xtaci/lossyconn v0.0.0-20200209145036-adba10fffc37 h1:EWU6Pktpas0n8lL github.com/xtaci/lossyconn v0.0.0-20200209145036-adba10fffc37/go.mod h1:HpMP7DB2CyokmAh4lp0EQnnWhmycP/TvwBGzvuie+H0= go.etcd.io/bbolt v1.3.2 h1:Z/90sZLPOeCy2PwprqkFa25PdkusRzaj9P8zm/KNyvk= go.etcd.io/bbolt v1.3.2/go.mod h1:IbVyRI1SCnLcuJnV2u8VeU0CEYM7e686BmAb1XKL+uU= +go.etcd.io/bbolt v1.3.4 h1:hi1bXHMVrlQh6WwxAy+qZCV/SYIlqo+Ushwdpa4tAKg= go.etcd.io/bbolt v1.3.4/go.mod h1:G5EMThwa9y8QZGBClrRx5EY+Yw9kAhnjy3bSjsnlVTQ= go.uber.org/atomic v1.4.0/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE= go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0= @@ -333,6 +360,7 @@ google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM= google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miEFZTKqfCUM6K7xSMQL9OKL/b6hQv+e19PK+JZNE= google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo= +google.golang.org/protobuf v1.23.0 h1:4MY060fB1DLGMB/7MBTLnwQUY6+F09GEiz6SsrNqyzM= google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= diff --git a/nameserver/metrics.go b/nameserver/metrics.go new file mode 100644 index 00000000..3bab7121 --- /dev/null +++ b/nameserver/metrics.go @@ -0,0 +1,21 @@ +package nameserver + +import ( + "github.com/safing/portbase/api" + "github.com/safing/portbase/config" + "github.com/safing/portbase/metrics" +) + +var requestsHistogram *metrics.Histogram + +func registerMetrics() (err error) { + requestsHistogram, err = metrics.NewHistogram( + "nameserver/request/duration/seconds", + nil, + &metrics.Options{ + Permission: api.PermitUser, + ExpertiseLevel: config.ExpertiseLevelExpert, + }) + + return err +} diff --git a/nameserver/module.go b/nameserver/module.go index cc4da029..c03dc369 100644 --- a/nameserver/module.go +++ b/nameserver/module.go @@ -33,7 +33,12 @@ func init() { } func prep() error { - return registerConfig() + err := registerConfig() + if err != nil { + return err + } + + return registerMetrics() } func start() error { diff --git a/nameserver/nameserver.go b/nameserver/nameserver.go index 167e668d..3a476f8a 100644 --- a/nameserver/nameserver.go +++ b/nameserver/nameserver.go @@ -5,6 +5,7 @@ import ( "errors" "net" "strings" + "time" "github.com/safing/portbase/log" "github.com/safing/portmaster/firewall" @@ -27,6 +28,10 @@ func handleRequestAsWorker(w dns.ResponseWriter, query *dns.Msg) { } func handleRequest(ctx context.Context, w dns.ResponseWriter, request *dns.Msg) error { //nolint:gocognit // TODO + // Record metrics. + startTime := time.Now() + defer requestsHistogram.UpdateDuration(startTime) + // Only process first question, that's how everyone does it. if len(request.Question) == 0 { return errors.New("missing question") diff --git a/network/connection.go b/network/connection.go index c9e4c739..99078c87 100644 --- a/network/connection.go +++ b/network/connection.go @@ -147,6 +147,9 @@ type Connection struct { //nolint:maligned // TODO: fix alignment // profile and required for correct re-evaluation of a connections // verdict. ProfileRevisionCounter uint64 + // addedToMetrics signifies if the connection has already been counted in + // the metrics. + addedToMetrics bool } // Reason holds information justifying a verdict, as well as additional @@ -449,6 +452,7 @@ func (conn *Connection) SaveWhenFinished() { // Callers must make sure to lock the connection itself before calling // Save(). func (conn *Connection) Save() { + conn.addToMetrics() conn.UpdateMeta() if !conn.KeyIsSet() { diff --git a/network/connection_store.go b/network/connection_store.go index 405eb563..18b753ea 100644 --- a/network/connection_store.go +++ b/network/connection_store.go @@ -55,3 +55,24 @@ func (cs *connectionStore) clone() map[string]*Connection { } return m } + +func (cs *connectionStore) len() int { + cs.rw.RLock() + defer cs.rw.RUnlock() + + return len(cs.items) +} + +func (cs *connectionStore) active() int { + // Clone and count all active connections. + var cnt int + for _, conn := range cs.clone() { + conn.Lock() + if conn.Ended != 0 { + cnt++ + } + conn.Unlock() + } + + return cnt +} diff --git a/network/metrics.go b/network/metrics.go new file mode 100644 index 00000000..d8972bda --- /dev/null +++ b/network/metrics.go @@ -0,0 +1,151 @@ +package network + +import ( + "github.com/safing/portbase/api" + "github.com/safing/portbase/config" + "github.com/safing/portbase/metrics" + "github.com/safing/portmaster/process" +) + +var ( + blockedOutConnCounter *metrics.Counter + encryptedAndTunneledOutConnCounter *metrics.Counter + encryptedOutConnCounter *metrics.Counter + tunneledOutConnCounter *metrics.Counter + outConnCounter *metrics.Counter +) + +func registerMetrics() error { + _, err := metrics.NewGauge( + "network/connections/active/total", + nil, + func() float64 { + return float64(conns.active()) + }, + &metrics.Options{ + Permission: api.PermitUser, + ExpertiseLevel: config.ExpertiseLevelUser, + }) + if err != nil { + return err + } + + connCounterID := "network/connections/total" + connCounterOpts := &metrics.Options{ + Name: "Connections", + Permission: api.PermitUser, + ExpertiseLevel: config.ExpertiseLevelUser, + Persist: true, + } + + blockedOutConnCounter, err = metrics.NewCounter( + connCounterID, + map[string]string{ + "direction": "out", + "blocked": "true", + }, + connCounterOpts, + ) + if err != nil { + return err + } + + encryptedAndTunneledOutConnCounter, err = metrics.NewCounter( + connCounterID, + map[string]string{ + "direction": "out", + "encrypted": "true", + "tunneled": "true", + }, + connCounterOpts, + ) + if err != nil { + return err + } + + encryptedOutConnCounter, err = metrics.NewCounter( + connCounterID, + map[string]string{ + "direction": "out", + "encrypted": "true", + }, + connCounterOpts, + ) + if err != nil { + return err + } + + tunneledOutConnCounter, err = metrics.NewCounter( + connCounterID, + map[string]string{ + "direction": "out", + "tunneled": "true", + }, + connCounterOpts, + ) + if err != nil { + return err + } + + outConnCounter, err = metrics.NewCounter( + connCounterID, + map[string]string{ + "direction": "out", + }, + connCounterOpts, + ) + if err != nil { + return err + } + + return nil +} + +func (conn *Connection) addToMetrics() { + if conn.addedToMetrics { + return + } + + // Don't count requests serviced to the network, + // as we have an incomplete view here. + if conn.Process() != nil && + conn.Process().Pid == process.NetworkHostProcessID { + return + } + + // Only count outgoing connections for now. + if conn.Inbound { + return + } + + // Check the verdict. + switch conn.Verdict { + case VerdictBlock, VerdictDrop: + blockedOutConnCounter.Inc() + conn.addedToMetrics = true + return + case VerdictAccept: + // Continue to next section. + default: + // Connection is not counted. + return + } + + // Only count successful connections, not DNS requests. + if conn.ID == "" { + return + } + + // Select counter based on attributes. + switch { + case conn.Encrypted && conn.Tunneled: + encryptedAndTunneledOutConnCounter.Inc() + case conn.Encrypted: + encryptedOutConnCounter.Inc() + case conn.Tunneled: + tunneledOutConnCounter.Inc() + default: + outConnCounter.Inc() + } + conn.addedToMetrics = true +} diff --git a/network/module.go b/network/module.go index a1ee69f5..e3ed28b0 100644 --- a/network/module.go +++ b/network/module.go @@ -11,7 +11,7 @@ var ( ) func init() { - module = modules.Register("network", nil, start, nil, "base", "processes") + module = modules.Register("network", prep, start, nil, "base", "processes") } // SetDefaultFirewallHandler sets the default firewall handler. @@ -21,6 +21,10 @@ func SetDefaultFirewallHandler(handler FirewallHandler) { } } +func prep() error { + return registerMetrics() +} + func start() error { err := registerAsDatabase() if err != nil {