commit 732a45e26ad6f31333c000f6a70115c2bf7de979 Author: James O'Gorman Date: Sun Oct 13 17:37:31 2019 +0100 Initial commit This adds a rudimentary `chaos` package for querying broadband info, and a Prometheus exporter. diff --git a/README.md b/README.md new file mode 100644 index 0000000..332b2fa --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Andrews and Arnold CHAOS API + +The `chaos` package allows interacting with the [Andrews and Arnold](https://aa.net.uk) CHAOS API. + +Implemented features: + +[x] Broadband info +[x] Broadband quota +[ ] Broadband PPP kill +[ ] Broadband ordering +[ ] Broadband availability checker +[ ] Broadband ordering +[ ] Login info +[ ] Login adjustment diff --git a/chaos.go b/chaos.go new file mode 100644 index 0000000..016f39c --- /dev/null +++ b/chaos.go @@ -0,0 +1,166 @@ +// Package chaos provides access to Andrews and Arnold's CHAOS v2 API. +package chaos + +import ( + "encoding/json" + "errors" + "fmt" + "io/ioutil" + "net/http" + "net/url" + "strings" + "time" +) + +const defaultEndpoint = "https://chaos2.aa.net.uk" + +// API provides the accessors for querying the CHAOS service. +type API struct { + Endpoint string + login url.Values +} + +// New takes an Auth with API credentials and returns an API object. +func New(auth Auth) *API { + return &API{Endpoint: defaultEndpoint, login: auth.form()} +} + +// Auth is the authentication credentials for the API. +// +// The API requires either account authentication (AccountNumber and AccountPassword) or control authentication (ControlLogin and ControlPassword.) +// +// ControlLogin may also be passed when using account authentication. +type Auth struct { + AccountNumber string + AccountPassword string + ControlLogin string + ControlPassword string +} + +// Construct form values for sending as authentication data. +func (a Auth) form() url.Values { + f := url.Values{} + if a.AccountNumber != "" { + f.Set("account_number", a.AccountNumber) + } + if a.AccountPassword != "" { + f.Set("account_password", a.AccountPassword) + } + if a.ControlLogin != "" { + f.Set("control_login", a.ControlLogin) + } + if a.ControlPassword != "" { + f.Set("control_password", a.ControlPassword) + } + return f +} + +func (api API) makeRequest(url string) ([]byte, error) { + client := &http.Client{ + Timeout: 10 * time.Second, + } + + req, err := http.NewRequest("POST", api.Endpoint+url, strings.NewReader(api.login.Encode())) + if err != nil { + return nil, err + } + req.Header.Set("Content-Type", "application/x-www-form-urlencoded") + resp, err := client.Do(req) + if err != nil { + return nil, err + } + + body, err := ioutil.ReadAll(resp.Body) + defer resp.Body.Close() + if err != nil { + return nil, fmt.Errorf("error reading response body: %w", err) + } + if resp.StatusCode != http.StatusOK { + return nil, fmt.Errorf("bad response code: %d", resp.StatusCode) + } + + return body, nil +} + +// The API returns timestamps in the format "YYYY-mm-dd HH:mm:ss" rather than RFC3389. +// +// Use a custom type to unmarshal JSON to this format. +type chaosTime struct { + time.Time +} + +func (t *chaosTime) UnmarshalJSON(b []byte) error { + s := strings.Trim(string(b), `"`) + // The API returns times in UK local rather than UTC + loc, err := time.LoadLocation("Europe/London") + if err != nil { + loc = time.Local + } + nt, err := time.ParseInLocation("2006-01-02 15:04:05", s, loc) + if err != nil { + return err + } + t.Time = nt + return nil +} + +// BroadbandInfo represents information about a broadband line. +type BroadbandInfo struct { + ID int `json:"id,string"` + Login string `json:"login"` + Postcode string `json:"postcode"` + TXRate int `json:"tx_rate,string"` + RXRate int `json:"rx_rate,string"` + TXRateAdjusted int `json:"tx_rate_adjusted,string"` + QuotaMonthly int `json:"quota_monthly,string"` + QuotaRemaining int `json:"quota_remaining,string"` + QuotaTimestamp chaosTime `json:"quota_timestamp"` +} + +// BroadbandInfo fetches broadband info. +func (api API) BroadbandInfo() ([]BroadbandInfo, error) { + resp, err := api.makeRequest("/broadband/info") + if err != nil { + return nil, err + } + r := struct { + Info []BroadbandInfo `json:"info"` + Error string `json:"error"` + }{} + err = json.Unmarshal(resp, &r) + if err != nil { + return nil, fmt.Errorf("BroadbandInfo JSON decode: %w", err) + } + if r.Error != "" { + return nil, errors.New(r.Error) + } + return r.Info, nil +} + +// BroadbandQuota is quota. +type BroadbandQuota struct { + ID int `json:"id,string"` + QuotaMonthly int `json:"quota_monthly"` + QuotaRemaining int `json:"quota_remaining,string"` + QuotaTimestamp chaosTime `json:"quota_timestamp,string"` +} + +// BroadbandQuota fetches the broadband quota. +func (api API) BroadbandQuota() ([]BroadbandQuota, error) { + resp, err := api.makeRequest("/broadband/quota") + if err != nil { + return nil, err + } + r := struct { + Quota []BroadbandQuota `json:"quota"` + Error string `json:"error"` + }{} + err = json.Unmarshal(resp, &r) + if err != nil { + return nil, fmt.Errorf("BroadbandQuota JSON decode: %w", err) + } + if r.Error != "" { + return nil, errors.New(r.Error) + } + return r.Quota, nil +} diff --git a/cmd/aaisp_exporter/README.md b/cmd/aaisp_exporter/README.md new file mode 100644 index 0000000..b32a617 --- /dev/null +++ b/cmd/aaisp_exporter/README.md @@ -0,0 +1,10 @@ +# AAISP Exporter + +A Prometheus exporter for information about [Andrews and Arnold](https://aa.net.uk) broadband lines. + +It exposes metrics: + +* **aaisp_broadband_quota_remaining**: The line's remaining in the current monthly quota in bytes +* **aaisp_broadband_quota_total**: The line's monthly quota in bytes, excluding rollover +* **aaisp_broadband_rx_rate**: The line's receive (upload) rate in bits per second +* **aaisp_broadband_tx_rate**: The line's transmit (download) rate in bits per second diff --git a/cmd/aaisp_exporter/main.go b/cmd/aaisp_exporter/main.go new file mode 100644 index 0000000..1821876 --- /dev/null +++ b/cmd/aaisp_exporter/main.go @@ -0,0 +1,98 @@ +package main + +import ( + "flag" + "log" + "net/http" + "os" + "strconv" + + chaos "github.com/jamesog/aaisp-chaos" + "github.com/prometheus/client_golang/prometheus" + "github.com/prometheus/client_golang/prometheus/promhttp" +) + +var ( + broadbandQuotaRemainingDesc = prometheus.NewDesc( + "aaisp_broadband_quota_remaining", + "Quota remaining in bytes", + []string{"line_id"}, + nil, + ) + broadbandQuotaTotalDesc = prometheus.NewDesc( + "aaisp_broadband_quota_total", + "Quota total in bytes", + []string{"line_id"}, + nil, + ) + broadbandTXRateDesc = prometheus.NewDesc( + "aaisp_broadband_tx_rate", + "Line transmit rate in bits per second", + []string{"line_id"}, + nil, + ) + broadbandRXRateDesc = prometheus.NewDesc( + "aaisp_broadband_rx_rate", + "Line receive rate in bits per second", + []string{"line_id"}, + nil, + ) +) + +type broadbandCollector struct { + *chaos.API +} + +func (bc broadbandCollector) Describe(ch chan<- *prometheus.Desc) { + prometheus.DescribeByCollect(bc, ch) +} + +func (bc broadbandCollector) Collect(ch chan<- prometheus.Metric) { + lines, err := bc.BroadbandInfo() + if err != nil { + log.Printf("error getting broadband info: %v\n", err) + return + } + for _, line := range lines { + ch <- prometheus.MustNewConstMetric( + broadbandQuotaRemainingDesc, + prometheus.GaugeValue, + float64(line.QuotaRemaining), + strconv.Itoa(line.ID), + ) + ch <- prometheus.MustNewConstMetric( + broadbandQuotaTotalDesc, + prometheus.CounterValue, + float64(line.QuotaMonthly), + strconv.Itoa(line.ID), + ) + ch <- prometheus.MustNewConstMetric( + broadbandTXRateDesc, + prometheus.GaugeValue, + float64(line.TXRate), + strconv.Itoa(line.ID), + ) + ch <- prometheus.MustNewConstMetric( + broadbandRXRateDesc, + prometheus.GaugeValue, + float64(line.RXRate), + strconv.Itoa(line.ID), + ) + } +} + +func main() { + listen := flag.String("listen", ":8080", "listen `address`") + flag.Parse() + + collector := broadbandCollector{ + API: chaos.New(chaos.Auth{ + ControlLogin: os.Getenv("CHAOS_CONTROL_LOGIN"), + ControlPassword: os.Getenv("CHAOS_CONTROL_PASSWORD"), + }), + } + + prometheus.MustRegister(collector) + http.Handle("/metrics", promhttp.Handler()) + log.Fatal(http.ListenAndServe(*listen, nil)) +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..f2d63d6 --- /dev/null +++ b/go.mod @@ -0,0 +1,5 @@ +module github.com/jamesog/aaisp-chaos + +go 1.13 + +require github.com/prometheus/client_golang v1.1.0 diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..23a5469 --- /dev/null +++ b/go.sum @@ -0,0 +1,68 @@ +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/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/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM= +github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as= +github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE= +github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk= +github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY= +github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ= +github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.2 h1:6nsPYzhq5kReh6QImI3k5qWzO4PEbvbIW2cwSfR/6xs= +github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= +github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= +github.com/json-iterator/go v1.1.6/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU= +github.com/json-iterator/go v1.1.7/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4= +github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7VTCxuUUipMqKk8s4w= +github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= +github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc= +github.com/matttproud/golang_protobuf_extensions v1.0.1 h1:4hp9jkHxhMHkqkrB3Ix0jegS5sx/RkqARlsWZ6pIwiU= +github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0= +github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= +github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= +github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= +github.com/pkg/errors v0.8.0 h1:WdK/asTD0HN+q6hsWO3/vpuAkAr+tw6aNJNDFFf0+qw= +github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/prometheus/client_golang v0.9.1/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw= +github.com/prometheus/client_golang v1.0.0/go.mod h1:db9x61etRT2tGnBNRi70OPL5FsnadC4Ky3P0J6CfImo= +github.com/prometheus/client_golang v1.1.0 h1:BQ53HtBmfOitExawJ6LokA4x8ov/z0SYYb0+HxJfRI8= +github.com/prometheus/client_golang v1.1.0/go.mod h1:I1FGZT9+L76gKKOs5djB6ezCbFQP1xR9D75/vuwEF3g= +github.com/prometheus/client_model v0.0.0-20180712105110-5c3871d89910/go.mod h1:MbSGuTsp3dbXC40dX6PRTWyKYBIrTGTE9sqQNg2J8bo= +github.com/prometheus/client_model v0.0.0-20190129233127-fd36f4220a90 h1:S/YWwWx/RA8rT8tKFRuGUZhuA90OyIBpPCXkcbwU8DE= +github.com/prometheus/client_model v0.0.0-20190129233127-fd36f4220a90/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= +github.com/prometheus/common v0.4.1/go.mod h1:TNfzLD0ON7rHzMJeJkieUDPYmFC7Snx/y86RQel1bk4= +github.com/prometheus/common v0.6.0 h1:kRhiuYSXR3+uv2IbVbZhUxK5zVD/2pp3Gd2PpvPkpEo= +github.com/prometheus/common v0.6.0/go.mod h1:eBmuwkDJBwy6iBfxCBob6t6dR6ENT/y+J+Zk0j9GMYc= +github.com/prometheus/procfs v0.0.0-20181005140218-185b4288413d/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk= +github.com/prometheus/procfs v0.0.2/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA= +github.com/prometheus/procfs v0.0.3 h1:CTwfnzjQ+8dS6MhHHu4YswVAD99sL2wjPqP+VkURmKE= +github.com/prometheus/procfs v0.0.3/go.mod h1:4A/X28fw3Fc593LaREMrKMqOKvUAntwMDaekg4FpcdQ= +github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190613194153-d28f0bde5980/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190801041406-cbf593c0f2f3 h1:4y9KwBHBgBNwDbtu44R5o1fdOCQUEXhbk/P4A9WmJq0= +golang.org/x/sys v0.0.0-20190801041406-cbf593c0f2f3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +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= +gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=