Skip to content

Commit

Permalink
[chore][receiver/splunkenterprise] Splunkent wire component (open-tel…
Browse files Browse the repository at this point in the history 
…emetry#32795)

**Description:** Graduate splunkenterprise receiver component to alpha

**Link to tracking Issue:**

**Testing:** Performed `make otelcontribcol` and ran resulting binary
with the following config:
```yaml
extensions:
    basicauth/indexer:
        client_auth:
            username: admin
            password: securityFirst
    basicauth/cluster_master:
        client_auth:
            username: admin
            password: securityFirst

receivers:
    splunkenterprise:
        indexer:
            auth:
              authenticator: basicauth/indexer
            endpoint: "https://localhost:8089/"
            timeout: 45s
        cluster_master:
            auth:
              authenticator: basicauth/cluster_master
            endpoint: "https://localhost:8089/"
            timeout: 45s

exporters:
  otlp:
    endpoint: 127.0.0.1:8000

service:
  extensions: [basicauth/indexer, basicauth/cluster_master]
  pipelines:
    metrics:
      receivers: [splunkenterprise]
      exporters: [otlp]
```

and received the following output:
```
sh ~> ./otelcontribcol_linux_amd64 --config=file:config.yaml
2024-05-08T17:34:33.032-0500 info [email protected]/service.go:102 Setting up own telemetry...
2024-05-08T17:34:33.032-0500 info [email protected]/telemetry.go:103 Serving metrics {"address": ":8888", "level": "Normal"}
2024-05-08T17:34:33.032-0500 info [email protected]/receiver.go:310 Development component. May change in the future. {"kind": "receiver", "name": "splunkenterprise", "data_type": "metrics"}
2024-05-08T17:34:33.033-0500 info [email protected]/service.go:169 Starting otelcontribcol... {"Version": "0.100.0-dev", "NumCPU": 16}
2024-05-08T17:34:33.033-0500 info extensions/extensions.go:34 Starting extensions...
2024-05-08T17:34:33.033-0500 info extensions/extensions.go:37 Extension is starting... {"kind": "extension", "name": "basicauth/cluster_master"}
2024-05-08T17:34:33.033-0500 info extensions/extensions.go:52 Extension started. {"kind": "extension", "name": "basicauth/cluster_master"}
2024-05-08T17:34:33.033-0500 info extensions/extensions.go:37 Extension is starting... {"kind": "extension", "name": "basicauth/indexer"}
2024-05-08T17:34:33.033-0500 info extensions/extensions.go:52 Extension started. {"kind": "extension", "name": "basicauth/indexer"}
2024-05-08T17:34:33.033-0500 info [email protected]/service.go:195 Everything is ready. Begin running and processing data.
```

indicating that the collector was able to successfully start with the
component configured.

**Documentation:** Documentation was updated to indicate change in
status from development to alpha

---------

Co-authored-by: Curtis Robert <[email protected]>
  • Loading branch information
@shalper2 @crobert-1
shalper2 and crobert-1 authored May 9, 2024
1 parent e57185c commit 7fd145b
Show file tree
Hide file tree
Showing 10 changed files with 22 additions and 4 deletions.
3 changes: 3 additions & 0 deletions cmd/configschema/go.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -587,6 +587,7 @@ require (
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/simpleprometheusreceiver v0.100.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/snmpreceiver v0.100.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/snowflakereceiver v0.100.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/splunkenterprisereceiver v0.100.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sqlqueryreceiver v0.100.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/statsdreceiver v0.100.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/wavefrontreceiver v0.100.0 // indirect
Expand Down Expand Up @@ -1224,3 +1225,5 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/extension/acke
replace github.com/open-telemetry/opentelemetry-collector-contrib/connector/grafanacloudconnector => ../../connector/grafanacloudconnector

replace github.com/open-telemetry/opentelemetry-collector-contrib/extension/sumologicextension => ../../extension/sumologicextension

replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/splunkenterprisereceiver => ../../receiver/splunkenterprisereceiver
2 changes: 2 additions & 0 deletions cmd/otelcontribcol/builder-config.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ receivers:
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/skywalkingreceiver v0.100.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/snowflakereceiver v0.100.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/solacereceiver v0.100.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/splunkenterprisereceiver v0.100.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/splunkhecreceiver v0.100.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sqlqueryreceiver v0.100.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sqlserverreceiver v0.100.0
Expand Down Expand Up @@ -458,3 +459,4 @@ replaces:
- github.com/open-telemetry/opentelemetry-collector-contrib/internal/sqlquery => ../../internal/sqlquery
- github.com/open-telemetry/opentelemetry-collector-contrib/extension/ackextension => ../../extension/ackextension
- github.com/open-telemetry/opentelemetry-collector-contrib/extension/googleclientauthextension => ../../extension/googleclientauthextension
- github.com/open-telemetry/opentelemetry-collector-contrib/receiver/splunkenterprisereceiver => ../../receiver/splunkenterprisereceiver
2 changes: 2 additions & 0 deletions cmd/otelcontribcol/components.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions cmd/otelcontribcol/go.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ require (
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/snmpreceiver v0.100.0
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/snowflakereceiver v0.100.0
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/solacereceiver v0.100.0
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/splunkenterprisereceiver v0.100.0
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/splunkhecreceiver v0.100.0
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sqlqueryreceiver v0.100.0
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sqlserverreceiver v0.100.0
Expand Down Expand Up @@ -1281,3 +1282,5 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/sqlqu
replace github.com/open-telemetry/opentelemetry-collector-contrib/extension/ackextension => ../../extension/ackextension

replace github.com/open-telemetry/opentelemetry-collector-contrib/extension/googleclientauthextension => ../../extension/googleclientauthextension

replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/splunkenterprisereceiver => ../../receiver/splunkenterprisereceiver
3 changes: 3 additions & 0 deletions cmd/otelcontribcol/receivers_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,9 @@ func TestDefaultReceivers(t *testing.T) {
{
receiver: "snowflake",
},
{
receiver: "splunkenterprise",
},
{
receiver: "splunk_hec",
},
Expand Down
3 changes: 3 additions & 0 deletions go.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ require (
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/snmpreceiver v0.100.0
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/snowflakereceiver v0.100.0
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/solacereceiver v0.100.0
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/splunkenterprisereceiver v0.100.0
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/splunkhecreceiver v0.100.0
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sqlqueryreceiver v0.100.0
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sqlserverreceiver v0.100.0
Expand Down Expand Up @@ -1224,3 +1225,5 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/extension/enco
replace github.com/open-telemetry/opentelemetry-collector-contrib/extension/encoding/otlpencodingextension => ./extension/encoding/otlpencodingextension

replace github.com/open-telemetry/opentelemetry-collector-contrib/extension/ackextension => ./extension/ackextension

replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/splunkenterprisereceiver => ./receiver/splunkenterprisereceiver
2 changes: 2 additions & 0 deletions internal/components/components.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ import (
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/snmpreceiver"
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/snowflakereceiver"
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/solacereceiver"
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/splunkenterprisereceiver"
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/splunkhecreceiver"
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sqlqueryreceiver"
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sqlserverreceiver"
Expand Down Expand Up @@ -286,6 +287,7 @@ func Components() (otelcol.Factories, error) {
snmpreceiver.NewFactory(),
snowflakereceiver.NewFactory(),
solacereceiver.NewFactory(),
splunkenterprisereceiver.NewFactory(),
splunkhecreceiver.NewFactory(),
sqlqueryreceiver.NewFactory(),
sqlserverreceiver.NewFactory(),
Expand Down
4 changes: 2 additions & 2 deletions receiver/splunkenterprisereceiver/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
<!-- status autogenerated section -->
| Status | |
| ------------- |-----------|
| Stability | [development]: metrics |
| Stability | [alpha]: metrics |
| Distributions | [] |
| Issues | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aopen%20label%3Areceiver%2Fsplunkenterprise%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Areceiver%2Fsplunkenterprise) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Areceiver%2Fsplunkenterprise%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Areceiver%2Fsplunkenterprise) |
| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner) | [@shalper2](https://www.github.com/shalper2), [@MovieStoreGuy](https://www.github.com/MovieStoreGuy), [@greatestusername](https://www.github.com/greatestusername) |

[development]: https://github.com/open-telemetry/opentelemetry-collector#development
[alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
<!-- end autogenerated section -->

The Splunk Enterprise Receiver is a pull based tool which enables the ingestion of performance metrics describing the operational status of a user's Splunk Enterprise deployment to an appropriate observability tool.
Expand Down
2 changes: 1 addition & 1 deletion receiver/splunkenterprisereceiver/internal/metadata/generated_status.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion receiver/splunkenterprisereceiver/metadata.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ scope_name: otelcol/splunkenterprisereceiver
status:
class: receiver
stability:
development: [metrics]
alpha: [metrics]
distributions:
codeowners:
active: [shalper2, MovieStoreGuy, greatestusername]
Expand Down

0 comments on commit 7fd145b

Please sign in to comment.