Skip to content

Commit

Permalink
Instrumentation Update (#58)
Browse files Browse the repository at this point in the history 
* simplify metrics

* Simplify metrics - keep the ones we need 4 now

* Add capacity type label

* Fix typo

* udpate changelog

* add Instrumentation back

* Unit test instrumenting service

* update changelog note

* revert header change for consistency for now

* drop defer for better readability

* capture start time correctly

* Minor fixes found while local testing

* Make up for missing read/write dynamo units

* Add query type label to dynamodb counter

* Change to trigger v0.3.6
  • Loading branch information
@joe94
joe94 authored Oct 2, 2020
1 parent 22b3c6d commit fd7d3e7
Show file tree
Hide file tree
Showing 10 changed files with 474 additions and 184 deletions.
9 changes: 7 additions & 2 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]


## [v0.3.6]
### Changed
- Abstract away dynamodb dependency. [#35](https://github.com/xmidt-org/argus/pull/35)
- Add unit tests for new dynamodb abstraction changes. [#39](https://github.com/xmidt-org/argus/pull/39)
Expand All @@ -13,11 +16,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Add helper functions for GetAllItems Handler. [#53](https://github.com/xmidt-org/argus/pull/53)
- Add helper functions for PushItem Handler. [#55](https://github.com/xmidt-org/argus/pull/55)
- Switch store provider to use new handlers. [#56](https://github.com/xmidt-org/argus/pull/56)

- Simplify metrics and add back instrumentation for dynamo. [#58](https://github.com/xmidt-org/argus/pull/58)

### Fixed
- Add back listener to chrysom config. [#54](https://github.com/xmidt-org/argus/pull/54)


## [v0.3.5]
### Changed
- Changed setting/getting logger in context to use xlog package. [#17](https://github.com/xmidt-org/argus/pull/17)
Expand Down Expand Up @@ -73,7 +77,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
## [v0.1.0] Tue May 07 2020 Jack Murdock - 0.1.0
- initial creation

[Unreleased]: https://github.com/xmidt-org/argus/compare/v0.3.5...HEAD
[Unreleased]: https://github.com/xmidt-org/argus/compare/v0.3.6...HEAD
[v0.3.6]: https://github.com/xmidt-org/argus/compare/v0.3.5...v0.3.6
[v0.3.5]: https://github.com/xmidt-org/argus/compare/v0.3.4...v0.3.5
[v0.3.4]: https://github.com/xmidt-org/argus/compare/v0.3.3...v0.3.4
[v0.3.3]: https://github.com/xmidt-org/argus/compare/v0.3.2...v0.3.3
Expand Down
26 changes: 14 additions & 12 deletions store/cassandra/db.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,16 @@ package cassandra

import (
"context"
"emperror.dev/emperror"
"errors"
"time"

"emperror.dev/emperror"
"github.com/gocql/gocql"
"github.com/xmidt-org/argus/model"
"github.com/xmidt-org/argus/store"
"github.com/xmidt-org/argus/store/db/metric"
dbmetric "github.com/xmidt-org/argus/store/db/metric"
"github.com/xmidt-org/webpa-common/logging"
"time"

"github.com/go-kit/kit/log"
"github.com/xmidt-org/themis/config"
Expand Down Expand Up @@ -179,10 +181,10 @@ func CreateCassandraClient(config CassandraConfig, measures metric.Measures, log
func (s *CassandraClient) Push(key model.Key, item store.OwnableItem) error {
err := s.client.Push(key, item)
if err != nil {
s.measures.SQLQueryFailureCount.With(store.TypeLabel, store.InsertType).Add(1.0)
s.measures.Queries.With(dbmetric.QueryTypeLabelKey, dbmetric.PushQueryType, dbmetric.QueryOutcomeLabelKey, dbmetric.FailQueryOutcome).Add(1)
return err
}
s.measures.SQLQuerySuccessCount.With(store.TypeLabel, store.InsertType).Add(1.0)
s.measures.Queries.With(dbmetric.QueryTypeLabelKey, dbmetric.PushQueryType, dbmetric.QueryOutcomeLabelKey, dbmetric.SuccessQueryOutcome).Add(1)
return nil
}

Expand All @@ -192,10 +194,10 @@ func (s *CassandraClient) Get(key model.Key) (store.OwnableItem, error) {
if err == noDataResponse {
return item, store.KeyNotFoundError{Key: key}
}
s.measures.SQLQueryFailureCount.With(store.TypeLabel, store.ReadType).Add(1.0)
s.measures.Queries.With(dbmetric.QueryTypeLabelKey, dbmetric.GetQueryType, dbmetric.QueryOutcomeLabelKey, dbmetric.FailQueryOutcome).Add(1)
return item, err
}
s.measures.SQLQuerySuccessCount.With(store.TypeLabel, store.ReadType).Add(1.0)
s.measures.Queries.With(dbmetric.QueryTypeLabelKey, dbmetric.GetQueryType, dbmetric.QueryOutcomeLabelKey, dbmetric.SuccessQueryOutcome).Add(1)
return item, nil
}

Expand All @@ -205,10 +207,10 @@ func (s *CassandraClient) Delete(key model.Key) (store.OwnableItem, error) {
if err == noDataResponse {
return item, store.KeyNotFoundError{Key: key}
}
s.measures.SQLQueryFailureCount.With(store.TypeLabel, store.DeleteType).Add(1.0)
s.measures.Queries.With(dbmetric.QueryTypeLabelKey, dbmetric.DeleteQueryType, dbmetric.QueryOutcomeLabelKey, dbmetric.FailQueryOutcome).Add(1)
return item, err
}
s.measures.SQLQuerySuccessCount.With(store.TypeLabel, store.DeleteType).Add(1.0)
s.measures.Queries.With(dbmetric.QueryTypeLabelKey, dbmetric.DeleteQueryType, dbmetric.QueryOutcomeLabelKey, dbmetric.SuccessQueryOutcome).Add(1)
return item, err
}

Expand All @@ -220,10 +222,10 @@ func (s *CassandraClient) GetAll(bucket string) (map[string]store.OwnableItem, e
Bucket: bucket,
}}
}
s.measures.SQLQueryFailureCount.With(store.TypeLabel, store.ReadType).Add(1.0)
s.measures.Queries.With(dbmetric.QueryTypeLabelKey, dbmetric.GetAllQueryType, dbmetric.QueryOutcomeLabelKey, dbmetric.FailQueryOutcome).Add(1)
return item, err
}
s.measures.SQLQuerySuccessCount.With(store.TypeLabel, store.ReadType).Add(1.0)
s.measures.Queries.With(dbmetric.QueryTypeLabelKey, dbmetric.GetAllQueryType, dbmetric.QueryOutcomeLabelKey, dbmetric.SuccessQueryOutcome).Add(1)
return item, err
}

Expand All @@ -235,10 +237,10 @@ func (s *CassandraClient) Close() {
func (s *CassandraClient) Ping() error {
err := s.client.Ping()
if err != nil {
s.measures.SQLQueryFailureCount.With(store.TypeLabel, store.PingType).Add(1.0)
s.measures.Queries.With(dbmetric.QueryTypeLabelKey, dbmetric.PingQueryType, dbmetric.QueryOutcomeLabelKey, dbmetric.FailQueryOutcome).Add(1)
return emperror.WrapWith(err, "Pinging connection failed")
}
s.measures.SQLQuerySuccessCount.With(store.TypeLabel, store.PingType).Add(1.0)
s.measures.Queries.With(dbmetric.QueryTypeLabelKey, dbmetric.PingQueryType, dbmetric.QueryOutcomeLabelKey, dbmetric.SuccessQueryOutcome).Add(1)
return nil
}

Expand Down
155 changes: 74 additions & 81 deletions store/cassandra/db_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,96 +18,89 @@
package cassandra

import (
"github.com/stretchr/testify/mock"
"github.com/xmidt-org/argus/store"
"github.com/xmidt-org/argus/store/db/metric"
"github.com/xmidt-org/argus/store/test"
"github.com/xmidt-org/webpa-common/logging"
"github.com/xmidt-org/webpa-common/xmetrics"
"github.com/xmidt-org/webpa-common/xmetrics/xmetricstest"
"testing"
)

func TestCassandra(t *testing.T) {
// TODO: Test metrics
// require := require.New(t)
mockDB := &test.MockDB{}
mockDB.On("Push", mock.Anything, mock.Anything).Return(nil)
mockDB.On("Get", mock.Anything).Return(test.GenericTestKeyPair.OwnableItem, nil).Once()
mockDB.On("Get", mock.Anything).Return(store.OwnableItem{}, nil).Once()
mockDB.On("Delete", mock.Anything, mock.Anything).Return(test.GenericTestKeyPair.OwnableItem, nil)
mockDB.On("GetAll", mock.Anything).Return(map[string]store.OwnableItem{"earth": test.GenericTestKeyPair.OwnableItem}, nil).Once()
mockDB.On("GetAll", mock.Anything).Return(map[string]store.OwnableItem{}, nil).Once()
// mockDB := &test.MockDB{}
// mockDB.On("Push", mock.Anything, mock.Anything).Return(nil)
// mockDB.On("Get", mock.Anything).Return(test.GenericTestKeyPair.OwnableItem, nil).Once()
// mockDB.On("Get", mock.Anything).Return(store.OwnableItem{}, nil).Once()
// mockDB.On("Delete", mock.Anything, mock.Anything).Return(test.GenericTestKeyPair.OwnableItem, nil)
// mockDB.On("GetAll", mock.Anything).Return(map[string]store.OwnableItem{"earth": test.GenericTestKeyPair.OwnableItem}, nil).Once()
// mockDB.On("GetAll", mock.Anything).Return(map[string]store.OwnableItem{}, nil).Once()

mockDB.On("Ping").Return(nil)
// mockDB.On("Ping").Return(nil)

p := xmetricstest.NewProvider(nil, func() []xmetrics.Metric {
return []xmetrics.Metric{
{
Name: metric.PoolInUseConnectionsGauge,
Type: "gauge",
Help: " The number of connections currently in use",
},
{
Name: metric.SQLDurationSeconds,
Type: "histogram",
Help: "A histogram of latencies for requests.",
Buckets: []float64{0.0625, 0.125, .25, .5, 1, 5, 10, 20, 40, 80, 160},
LabelNames: []string{store.TypeLabel},
},
{
Name: metric.SQLQuerySuccessCounter,
Type: "counter",
Help: "The total number of successful SQL queries",
LabelNames: []string{store.TypeLabel},
},
{
Name: metric.SQLQueryFailureCounter,
Type: "counter",
Help: "The total number of failed SQL queries",
LabelNames: []string{store.TypeLabel},
},
{
Name: metric.SQLInsertedRecordsCounter,
Type: "counter",
Help: "The total number of rows inserted",
},
{
Name: metric.SQLReadRecordsCounter,
Type: "counter",
Help: "The total number of rows read",
},
{
Name: metric.SQLDeletedRecordsCounter,
Type: "counter",
Help: "The total number of rows deleted",
},
}
})
// p := xmetricstest.NewProvider(nil, func() []xmetrics.Metric {
// return []xmetrics.Metric{
// {
// Name: metric.PoolInUseConnectionsGauge,
// Type: "gauge",
// Help: " The number of connections currently in use",
// },
// {
// Name: metric.SQLDurationSeconds,
// Type: "histogram",
// Help: "A histogram of latencies for requests.",
// Buckets: []float64{0.0625, 0.125, .25, .5, 1, 5, 10, 20, 40, 80, 160},
// LabelNames: []string{store.TypeLabel},
// },
// {
// Name: metric.SQLQuerySuccessCounter,
// Type: "counter",
// Help: "The total number of successful SQL queries",
// LabelNames: []string{store.TypeLabel},
// },
// {
// Name: metric.SQLQueryFailureCounter,
// Type: "counter",
// Help: "The total number of failed SQL queries",
// LabelNames: []string{store.TypeLabel},
// },
// {
// Name: metric.SQLInsertedRecordsCounter,
// Type: "counter",
// Help: "The total number of rows inserted",
// },
// {
// Name: metric.SQLReadRecordsCounter,
// Type: "counter",
// Help: "The total number of rows read",
// },
// {
// Name: metric.SQLDeletedRecordsCounter,
// Type: "counter",
// Help: "The total number of rows deleted",
// },
// }
// })

s := &CassandraClient{
client: mockDB,
config: CassandraConfig{},
logger: logging.NewTestLogger(nil, t),
measures: metric.Measures{
PoolInUseConnections: p.NewGauge(metric.PoolInUseConnectionsGauge),
SQLDuration: p.NewHistogram(metric.SQLDurationSeconds, 11),
SQLQuerySuccessCount: p.NewCounter(metric.SQLQuerySuccessCounter),
SQLQueryFailureCount: p.NewCounter(metric.SQLQueryFailureCounter),
SQLInsertedRecords: p.NewCounter(metric.SQLInsertedRecordsCounter),
SQLReadRecords: p.NewCounter(metric.SQLReadRecordsCounter),
SQLDeletedRecords: p.NewCounter(metric.SQLDeletedRecordsCounter),
},
}
p.Assert(t, metric.SQLQuerySuccessCounter)(xmetricstest.Value(0.0))
p.Assert(t, metric.SQLQueryFailureCounter)(xmetricstest.Value(0.0))
// s := &CassandraClient{
// client: mockDB,
// config: CassandraConfig{},
// logger: logging.NewTestLogger(nil, t),
// measures: metric.Measures{
// PoolInUseConnections: p.NewGauge(metric.PoolInUseConnectionsGauge),
// SQLDuration: p.NewHistogram(metric.SQLDurationSeconds, 11),
// SQLQuerySuccessCount: p.NewCounter(metric.SQLQuerySuccessCounter),
// SQLQueryFailureCount: p.NewCounter(metric.SQLQueryFailureCounter),
// SQLInsertedRecords: p.NewCounter(metric.SQLInsertedRecordsCounter),
// SQLReadRecords: p.NewCounter(metric.SQLReadRecordsCounter),
// SQLDeletedRecords: p.NewCounter(metric.SQLDeletedRecordsCounter),
// },
// }
// p.Assert(t, metric.SQLQuerySuccessCounter)(xmetricstest.Value(0.0))
// p.Assert(t, metric.SQLQueryFailureCounter)(xmetricstest.Value(0.0))

test.StoreTest(s, 0, t)
p.Assert(t, metric.SQLQuerySuccessCounter, store.TypeLabel, store.ReadType)(xmetricstest.Value(3.0))
p.Assert(t, metric.SQLQuerySuccessCounter, store.TypeLabel, store.InsertType)(xmetricstest.Value(1.0))
p.Assert(t, metric.SQLQuerySuccessCounter, store.TypeLabel, store.DeleteType)(xmetricstest.Value(1.0))
p.Assert(t, metric.SQLInsertedRecordsCounter)(xmetricstest.Value(0.0))
p.Assert(t, metric.SQLReadRecordsCounter)(xmetricstest.Value(0.0))
p.Assert(t, metric.SQLDeletedRecordsCounter)(xmetricstest.Value(0.0))
// test.StoreTest(s, 0, t)
// p.Assert(t, metric.SQLQuerySuccessCounter, store.TypeLabel, store.ReadType)(xmetricstest.Value(3.0))
// p.Assert(t, metric.SQLQuerySuccessCounter, store.TypeLabel, store.InsertType)(xmetricstest.Value(1.0))
// p.Assert(t, metric.SQLQuerySuccessCounter, store.TypeLabel, store.DeleteType)(xmetricstest.Value(1.0))
// p.Assert(t, metric.SQLInsertedRecordsCounter)(xmetricstest.Value(0.0))
// p.Assert(t, metric.SQLReadRecordsCounter)(xmetricstest.Value(0.0))
// p.Assert(t, metric.SQLDeletedRecordsCounter)(xmetricstest.Value(0.0))

}
Loading

0 comments on commit fd7d3e7

Please sign in to comment.