Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[receiver/riak] - Fix issue where user configured metric settings were ignored #9561

Merged
merged 15 commits into from
May 2, 2022
Merged

[receiver/riak] - Fix issue where user configured metric settings were ignored #9561

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
9a10e2f
empty commit
armstrmi Apr 8, 2022
1dbb43f
empty commit
armstrmi Apr 8, 2022
1847197
quick fix for newScraper method, e.g. no default
armstrmi Apr 27, 2022
3698871
added missing dependencies
armstrmi Apr 28, 2022
c5621c2
make gotidy
armstrmi Apr 28, 2022
767817a
added changelog
armstrmi Apr 28, 2022
92fd98e
empty commit, relaunch flaky test
armstrmi Apr 28, 2022
9b3a7a7
empty commit, rerun tests
armstrmi Apr 29, 2022
289a26e
added scraper test with some metrics disabled
armstrmi Apr 29, 2022
88d79d7
cleaned up unnecessary tests
armstrmi Apr 29, 2022
4d7f8b2
implemented recommended changes
armstrmi May 2, 2022
91f4c34
removed metricsDisabled boolean from scraper_test
armstrmi May 2, 2022
d6ef390
implemented feedback
armstrmi May 2, 2022
fad8097
removed space after newline
armstrmi May 2, 2022
8071e1e
Merge branch 'main' into riak_scraper_fix
djaglowski May 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
- `resourcedetectionprocessor`: Wire docker detector (#9372)
- `kafkametricsreceiver`: The kafkametricsreceiver was changed to connect to kafka during scrape, rather than startup. If kafka is unavailable the receiver will attempt to connect during subsequent scrapes until succcessful (#8817).
- `datadogexporter`: Update Kubernetes example manifest to new executable name. (#9425).
- `riakreceiver`: Updated newScraper method to implement given configs Metric Settings. (#9561)
djaglowski marked this conversation as resolved.
Show resolved Hide resolved

## v0.49.0

Expand Down
2 changes: 1 addition & 1 deletion receiver/riakreceiver/scraper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ func newScraper(logger *zap.Logger, cfg *Config, settings component.TelemetrySet
logger: logger,
cfg: cfg,
settings: settings,
mb: metadata.NewMetricsBuilder(metadata.DefaultMetricsSettings()),
mb: metadata.NewMetricsBuilder(cfg.Metrics),
}
}

Expand Down
68 changes: 63 additions & 5 deletions receiver/riakreceiver/scraper_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import (

"github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest"
"github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest/golden"
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/riakreceiver/internal/metadata"
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/riakreceiver/internal/mocks"
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/riakreceiver/internal/model"
)
Expand Down Expand Up @@ -58,6 +59,7 @@ func TestScraperStart(t *testing.T) {
},
expectError: true,
},

{
desc: "Valid Config",
scraper: &riakScraper{
Expand Down Expand Up @@ -90,6 +92,7 @@ func TestScaperScrape(t *testing.T) {
desc string
setupMockClient func(t *testing.T) client
expectedMetricGen func(t *testing.T) pmetric.Metrics
metricsEnabled bool
djaglowski marked this conversation as resolved.
Show resolved Hide resolved
expectedErr error
}{
{
Expand All @@ -100,7 +103,8 @@ func TestScaperScrape(t *testing.T) {
expectedMetricGen: func(t *testing.T) pmetric.Metrics {
return pmetric.NewMetrics()
},
expectedErr: errClientNotInit,
expectedErr: errClientNotInit,
metricsEnabled: true,
},
{
desc: "API Call Failure",
Expand All @@ -112,7 +116,30 @@ func TestScaperScrape(t *testing.T) {
expectedMetricGen: func(t *testing.T) pmetric.Metrics {
return pmetric.NewMetrics()
},
expectedErr: errors.New("some api error"),
metricsEnabled: true,
expectedErr: errors.New("some api error"),
},
{
desc: "Metrics Disabled",
setupMockClient: func(t *testing.T) client {
mockClient := mocks.MockClient{}
// use helper function from client tests
data := loadAPIResponseData(t, statsAPIResponseFile)
var stats *model.Stats
err := json.Unmarshal(data, &stats)
require.NoError(t, err)

mockClient.On("GetStats", mock.Anything).Return(stats, nil)
return &mockClient
},
expectedMetricGen: func(t *testing.T) pmetric.Metrics {
goldenPath := filepath.Join("testdata", "scraper", "expected_disabled.json")
expectedMetrics, err := golden.ReadMetrics(goldenPath)
require.NoError(t, err)
return expectedMetrics
},
metricsEnabled: false,
expectedErr: nil,
},
{
desc: "Successful Collection",
Expand All @@ -133,16 +160,24 @@ func TestScaperScrape(t *testing.T) {
require.NoError(t, err)
return expectedMetrics
},
expectedErr: nil,
metricsEnabled: true,
expectedErr: nil,
},
}

for _, tc := range testCases {
t.Run(tc.desc, func(t *testing.T) {
scraper := newScraper(zap.NewNop(), createDefaultConfig().(*Config), componenttest.NewNopTelemetrySettings())
var scraper *riakScraper
if !tc.metricsEnabled {
cfg := createDefaultConfig().(*Config)
cfg.Metrics = customMetricSettings()
scraper = newScraper(zap.NewNop(), cfg, componenttest.NewNopTelemetrySettings())
} else {
scraper = newScraper(zap.NewNop(), createDefaultConfig().(*Config), componenttest.NewNopTelemetrySettings())
}

scraper.client = tc.setupMockClient(t)
actualMetrics, err := scraper.scrape(context.Background())

if tc.expectedErr == nil {
require.NoError(t, err)
} else {
Expand All @@ -156,3 +191,26 @@ func TestScaperScrape(t *testing.T) {
})
}
}

func customMetricSettings() metadata.MetricsSettings {
return metadata.MetricsSettings{
RiakMemoryLimit: metadata.MetricSettings{
Enabled: false,
},
RiakNodeOperationCount: metadata.MetricSettings{
Enabled: false,
},
RiakNodeOperationTimeMean: metadata.MetricSettings{
Enabled: true,
},
RiakNodeReadRepairCount: metadata.MetricSettings{
Enabled: true,
},
RiakVnodeIndexOperationCount: metadata.MetricSettings{
Enabled: true,
},
RiakVnodeOperationCount: metadata.MetricSettings{
Enabled: true,
},
}
}
djaglowski marked this conversation as resolved.
Show resolved Hide resolved
163 changes: 163 additions & 0 deletions receiver/riakreceiver/testdata/scraper/expected_disabled.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
{
"resourceMetrics": [
{
"instrumentationLibraryMetrics": [
{
"instrumentationLibrary": {
"name": "otelcol/riakreceiver"
},
"metrics": [
{
"description": "The mean time between request and response for operations performed by the node over the last minute.",
"gauge": {
"dataPoints": [
{
"asInt": "4",
"attributes": [
{
"key": "request",
"value": {
"stringValue": "get"
}
}
],
"startTimeUnixNano": "1648220661611816000",
"timeUnixNano": "1648220661612587000"
},
{
"asInt": "5",
"attributes": [
{
"key": "request",
"value": {
"stringValue": "put"
}
}
],
"startTimeUnixNano": "1648220661611816000",
"timeUnixNano": "1648220661612587000"
}
]
},
"name": "riak.node.operation.time.mean",
"unit": "us"
},
{
"description": "The number of read repairs performed by the node.",
"name": "riak.node.read_repair.count",
"sum": {
"aggregationTemporality": "AGGREGATION_TEMPORALITY_CUMULATIVE",
"dataPoints": [
{
"asInt": "0",
"startTimeUnixNano": "1648220661611816000",
"timeUnixNano": "1648220661612587000"
}
],
"isMonotonic": true
},
"unit": "{read_repair}"
},
{
"description": "The number of index operations performed by vnodes on the node.",
"name": "riak.vnode.index.operation.count",
"sum": {
"aggregationTemporality": "AGGREGATION_TEMPORALITY_CUMULATIVE",
"dataPoints": [
{
"asInt": "10",
"attributes": [
{
"key": "operation",
"value": {
"stringValue": "read"
}
}
],
"startTimeUnixNano": "1648220661611816000",
"timeUnixNano": "1648220661612587000"
},
{
"asInt": "11",
"attributes": [
{
"key": "operation",
"value": {
"stringValue": "write"
}
}
],
"startTimeUnixNano": "1648220661611816000",
"timeUnixNano": "1648220661612587000"
},
{
"asInt": "9",
"attributes": [
{
"key": "operation",
"value": {
"stringValue": "delete"
}
}
],
"startTimeUnixNano": "1648220661611816000",
"timeUnixNano": "1648220661612587000"
}
]
},
"unit": "{operation}"
},
{
"description": "The number of operations performed by vnodes on the node.",
"name": "riak.vnode.operation.count",
"sum": {
"aggregationTemporality": "AGGREGATION_TEMPORALITY_CUMULATIVE",
"dataPoints": [
{
"asInt": "7",
"attributes": [
{
"key": "request",
"value": {
"stringValue": "get"
}
}
],
"startTimeUnixNano": "1648220661611816000",
"timeUnixNano": "1648220661612587000"
},
{
"asInt": "8",
"attributes": [
{
"key": "request",
"value": {
"stringValue": "put"
}
}
],
"startTimeUnixNano": "1648220661611816000",
"timeUnixNano": "1648220661612587000"
}
],
"isMonotonic": true
},
"unit": "{operation}"
}
]
}
],
"resource": {
"attributes": [
{
"key": "riak.node.name",
"value": {
"stringValue": "riak@127.0.0.1"
}
}
]
}
}
]
}

djaglowski marked this conversation as resolved.
Show resolved Hide resolved
djaglowski marked this conversation as resolved.
Show resolved Hide resolved