[windowsservicereceiver] Initial implementation #42545
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| //go:build !windows | ||
|
pjanotti marked this conversation as resolved.
|
||
|
|
||
| package windowsservicereceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/windowsservicereceiver" | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "time" | ||
|
|
||
| "go.opentelemetry.io/collector/component" | ||
| "go.opentelemetry.io/collector/consumer" | ||
| "go.opentelemetry.io/collector/receiver" | ||
| "go.opentelemetry.io/collector/scraper/scraperhelper" | ||
|
|
||
| "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/windowsservicereceiver/internal/metadata" | ||
| ) | ||
|
|
||
| var errUnsupportedOS = errors.New("windowsservicereceiver: supported only on Windows") | ||
|
|
||
| func NewFactory() receiver.Factory { | ||
|
Contributor
There was a problem hiding this comment. At first I think this will be better if you have the same |
||
| return receiver.NewFactory( | ||
| metadata.Type, | ||
| createDefaultConfig, | ||
| receiver.WithMetrics(createUnsupported, metadata.MetricsStability), | ||
| ) | ||
| } | ||
|
|
||
| func createDefaultConfig() component.Config { | ||
|
Contributor
There was a problem hiding this comment. This same function is also defined in Side note: the suffix of the file names in go, e.g.: |
||
| return &Config{ | ||
| ControllerConfig: scraperhelper.ControllerConfig{ | ||
| CollectionInterval: 1 * time.Minute, | ||
| }, | ||
| MetricsBuilderConfig: metadata.DefaultMetricsBuilderConfig(), | ||
| IncludeServices: nil, | ||
| ExcludeServices: nil, | ||
| } | ||
| } | ||
|
|
||
| func createUnsupported( | ||
|
pjanotti marked this conversation as resolved.
Outdated
|
||
| _ context.Context, | ||
| _ receiver.Settings, | ||
| _ component.Config, | ||
| _ consumer.Metrics, | ||
| ) (receiver.Metrics, error) { | ||
| return nil, errUnsupportedOS | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,48 +1,134 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| //go:build windows | ||
|
|
||
| package windowsservicereceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/windowsservicereceiver" | ||
|
|
||
| import ( | ||
| "context" | ||
| "time" | ||
|
|
||
| "go.opentelemetry.io/collector/component" | ||
| "go.opentelemetry.io/collector/pdata/pcommon" | ||
| "go.opentelemetry.io/collector/pdata/pmetric" | ||
| "go.opentelemetry.io/collector/receiver" | ||
| "go.uber.org/multierr" | ||
| "go.uber.org/zap" | ||
|
|
||
| "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/windowsservicereceiver/internal/metadata" | ||
| ) | ||
|
|
||
| type windowsServiceScraper struct { | ||
| logger *zap.Logger | ||
| cfg *Config | ||
| mb *metadata.MetricsBuilder | ||
| mgr serviceManager | ||
| includeSet map[string]struct{} | ||
| excludeSet map[string]struct{} | ||
| } | ||
|
|
||
| func newWindowsServiceScraper(settings receiver.Settings, cfg *Config, mb *metadata.MetricsBuilder) *windowsServiceScraper { | ||
| ws := &windowsServiceScraper{ | ||
| logger: settings.Logger, | ||
| cfg: cfg, | ||
| mb: mb, | ||
| mgr: serviceManager{}, | ||
| } | ||
| if len(cfg.IncludeServices) > 0 { | ||
| ws.includeSet = make(map[string]struct{}, len(cfg.IncludeServices)) | ||
| for _, n := range cfg.IncludeServices { | ||
| ws.includeSet[n] = struct{}{} | ||
| } | ||
| } | ||
| if len(cfg.ExcludeServices) > 0 { | ||
| ws.excludeSet = make(map[string]struct{}, len(cfg.ExcludeServices)) | ||
| for _, n := range cfg.ExcludeServices { | ||
| ws.excludeSet[n] = struct{}{} | ||
| } | ||
| } | ||
| return ws | ||
| } | ||
|
|
||
| func mapStartTypeToAttr(st StartType) metadata.AttributeStartupMode { | ||
| switch st { | ||
| case StartBoot: | ||
| return metadata.AttributeStartupModeBootStart | ||
| case StartSystem: | ||
| return metadata.AttributeStartupModeSystemStart | ||
| case StartAutomatic: | ||
| return metadata.AttributeStartupModeAutoStart | ||
| case StartManual: | ||
| return metadata.AttributeStartupModeDemandStart | ||
| case StartDisabled: | ||
| return metadata.AttributeStartupModeDisabled | ||
| default: | ||
| return metadata.AttributeStartupModeDemandStart | ||
| } | ||
| } | ||
|
|
||
| func (ws *windowsServiceScraper) start(_ context.Context, _ component.Host) error { | ||
| return ws.mgr.connect() | ||
| } | ||
|
|
||
| func (ws *windowsServiceScraper) shutdown(_ context.Context) error { | ||
| return ws.mgr.disconnect() | ||
| } | ||
|
|
||
| func (ws *windowsServiceScraper) allowed(name string) bool { | ||
| if len(ws.includeSet) > 0 { | ||
| if _, ok := ws.includeSet[name]; !ok { | ||
| return false | ||
| } | ||
| } | ||
| if _, banned := ws.excludeSet[name]; banned { | ||
| return false | ||
| } | ||
| return true | ||
| } | ||
|
|
||
| func (ws *windowsServiceScraper) scrape(_ context.Context) (pmetric.Metrics, error) { | ||
| ts := pcommon.NewTimestampFromTime(time.Now()) | ||
|
|
||
| names, err := ws.mgr.listServices() | ||
| if err != nil { | ||
| return ws.mb.Emit(), err | ||
| } | ||
|
|
||
| var scrapeErr error | ||
|
|
||
| for _, name := range names { | ||
|
atoulme marked this conversation as resolved.
|
||
| if !ws.allowed(name) { | ||
| continue | ||
| } | ||
|
|
||
| svc, err := updateService(&ws.mgr, name) | ||
| if err != nil { | ||
| scrapeErr = multierr.Append(scrapeErr, err) | ||
| continue | ||
| } | ||
|
|
||
| func() { | ||
|
pjanotti marked this conversation as resolved.
Outdated
|
||
| defer func() { _ = svc.close() }() | ||
|
|
||
| if err := svc.updateStatus(); err != nil { | ||
| scrapeErr = multierr.Append(scrapeErr, err) | ||
| return | ||
| } | ||
| if err := svc.updateConfig(); err != nil { | ||
| scrapeErr = multierr.Append(scrapeErr, err) | ||
| return | ||
| } | ||
|
|
||
| val := int64(svc.status.State) | ||
|
|
||
| if val < 1 || val > 7 { | ||
| val = 0 | ||
| } | ||
|
|
||
| startAttr := mapStartTypeToAttr(svc.config.StartType) | ||
| ws.mb.RecordWindowsServiceStatusDataPoint(ts, val, name, startAttr) | ||
| }() | ||
| } | ||
|
|
||
| return ws.mb.Emit(), scrapeErr | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since there is a file named
factory_windows.gothis file,factory.go, is expected to have code that is common to all platforms and this file should not need this compile directive.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This directive shouldn't be necessary anymore... I see that it is still needed because there is still a
NewFactoryimplementation infactory_others.go...