Skip to content

Commit

Permalink
fix: update package name for component to match full path (#62)
Browse files Browse the repository at this point in the history 
### Description

Added `github.com/observeinc` prefix to package name for component to
match fully qualified package path. Also updated `README.md` to reflect
new processor and docs for `init-config` command.

### Checklist
- [ ] Created tests which fail without the change (if possible)
- [ ] Extended the README / documentation, if necessary
  • Loading branch information
@obs-gh-alexlew
obs-gh-alexlew authored Jul 25, 2024
1 parent 1ab3090 commit 17414a9
Show file tree
Hide file tree
Showing 18 changed files with 86 additions and 327 deletions.
41 changes: 21 additions & 20 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,26 +41,26 @@ Current OTEL Collector Version: `v0.105.0`

This section lists the components that are included in the Observe Distribution of the OpenTelemetry Collector.

| Receivers | Processors | Exporters | Extensions | Connectors |
|----------------------------------------------------------|-------------------------------------------------|------------------------------|--------------------------------------|-----------------------------|
| [awsecscontainermetrics][awsecscontainermetricsreceiver] | [attributes][attributesprocessor] | [debug][debugexporter] | [file_storage][filestorage] | [count][countconnector] |
| [docker_stats][dockerstatsreceiver] | [batch][batchprocessor] | [file][fileexporter] | [health_check][healthcheckextension] | [forward][forwardconnector] |
| [elasticsearch][elasticsearchreceiver] | [filter][filterprocessor] | [otlphttp][otlphttpexporter] | [zpages][zpagesextension] | |
| [filelog][filelogreceiver] | [k8sattributes][k8sattributesprocessor] | | | |
| [filestats][filestatsreceiver] | [memory_limiter][memorylimiterprocessor] | | | |
| [hostmetrics][hostmetricsreceiver] | [resourcedetection][resourcedetectionprocessor] | | | |
| [iis][iisreceiver] | [transform][transformprocessor] | | | |
| [journald][journaldreceiver] | | | | |
| [k8s_cluster][k8sclusterreceiver] | | | | |
| [k8sobjects][k8sobjectsreceiver] | | | | |
| [kafkametrics][kafkametricsreceiver] | | | | |
| [kafka][kafkareceiver] | | | | |
| [kubeletstats][kubeletstatsreceiver] | | | | |
| [otlp][otlpreceiver] | | | | |
| [prometheus][prometheusreceiver] | | | | |
| [redis][redisreceiver] | | | | |
| [statsd][statsdreceiver] | | | | |
| [windowseventlog][windowseventlogreceiver] | | | | |
| Receivers | Processors | Exporters | Extensions | Connectors |
|----------------------------------------------------------|-------------------------------------------------------|------------------------------|--------------------------------------|-----------------------------|
| [awsecscontainermetrics][awsecscontainermetricsreceiver] | [attributes][attributesprocessor] | [debug][debugexporter] | [file_storage][filestorage] | [count][countconnector] |
| [docker_stats][dockerstatsreceiver] | [batch][batchprocessor] | [file][fileexporter] | [health_check][healthcheckextension] | [forward][forwardconnector] |
| [elasticsearch][elasticsearchreceiver] | [filter][filterprocessor] | [otlphttp][otlphttpexporter] | [zpages][zpagesextension] | |
| [filelog][filelogreceiver] | [k8sattributes][k8sattributesprocessor] | | | |
| [filestats][filestatsreceiver] | [memory_limiter][memorylimiterprocessor] | | | |
| [hostmetrics][hostmetricsreceiver] | [observek8sattributes][observek8sattributesprocessor] | | | |
| [iis][iisreceiver] | [resourcedetection][resourcedetectionprocessor] | | | |
| [journald][journaldreceiver] | [transform][transformprocessor] | | | |
| [k8s_cluster][k8sclusterreceiver] | | | | |
| [k8sobjects][k8sobjectsreceiver] | | | | |
| [kafkametrics][kafkametricsreceiver] | | | | |
| [kafka][kafkareceiver] | | | | |
| [kubeletstats][kubeletstatsreceiver] | | | | |
| [otlp][otlpreceiver] | | | | |
| [prometheus][prometheusreceiver] | | | | |
| [redis][redisreceiver] | | | | |
| [statsd][statsdreceiver] | | | | |
| [windowseventlog][windowseventlogreceiver] | | | | |

[awsecscontainermetricsreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.105.0/receiver/awsecscontainermetricsreceiver
[dockerstatsreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.105.0/receiver/dockerstatsreceiver
Expand All @@ -85,6 +85,7 @@ This section lists the components that are included in the Observe Distribution
[filterprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.105.0/processor/filterprocessor
[k8sattributesprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.105.0/processor/k8sattributesprocessor
[memorylimiterprocessor]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.105.0/processor/memorylimiterprocessor
[observek8sattributesprocessor]: ./components/processors/observek8sattributesprocessor
[resourcedetectionprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.105.0/processor/resourcedetectionprocessor
[transformprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.105.0/processor/transformprocessor
[debugexporter]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.105.0/exporter/debugexporter
Expand Down
2 changes: 1 addition & 1 deletion cmd/commands/initconfig/initconfig.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ func NewConfigureCmd() *cobra.Command {
return &cobra.Command{
Use: "init-config",
Short: "Initialize agent configuration",
Long: `This command takes in parameters and creates an initialized observe agent configuration file. Will overwrite existing config files with default values.`,
Long: `This command takes in parameters and creates an initialized observe agent configuration file. Will overwrite existing config file and should only be used to initialize.`,
RunE: func(cmd *cobra.Command, args []string) error {
configValues := FlatAgentConfig{
Token: viper.GetString("token"),
Expand Down
6 changes: 4 additions & 2 deletions components/processors/observek8sattributesprocessor/factory.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ package observek8sattributesprocessor
import (
"context"

"github.com/observeinc/observe-agent/components/processors/observek8sattributesprocessor/internal/metadata"

"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/consumer"
"go.opentelemetry.io/collector/processor"
Expand All @@ -13,9 +15,9 @@ var processorCapabilities = consumer.Capabilities{MutatesData: true}

func NewFactory() processor.Factory {
return processor.NewFactory(
Type,
metadata.Type,
createDefaultConfig,
processor.WithLogs(createLogsProcessor, LogsStability),
processor.WithLogs(createLogsProcessor, metadata.LogsStability),
)
}

Expand Down
43 changes: 43 additions & 0 deletions components/processors/observek8sattributesprocessor/generated_component_test.go
View file

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

17 changes: 0 additions & 17 deletions components/processors/observek8sattributesprocessor/generated_status.go
View file

This file was deleted.

2 changes: 1 addition & 1 deletion components/processors/observek8sattributesprocessor/go.mod
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module observe-agent/components/processors/observek8sattributesprocessor
module github.com/observeinc/observe-agent/components/processors/observek8sattributesprocessor

go 1.22.3

Expand Down
15 changes: 15 additions & 0 deletions components/processors/observek8sattributesprocessor/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 components/processors/observek8sattributesprocessor/metadata.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ scope_name: observe-agent/processor/observek8sattributes
status:
class: processor
stability:
beta: [traces, metrics, logs]
beta: [logs]
2 changes: 0 additions & 2 deletions go.work
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,3 @@ use (
./cmd/collector
./components/processors/observek8sattributesprocessor
)

replace github.com/observeinc/observe-agent/components/processors/observek8sattributesprocessor => ./components/processors/observek8sattributesprocessor
12 changes: 0 additions & 12 deletions ...inc/observe-agent/components/processors/observek8sattributesprocessor/README.md
View file

This file was deleted.

8 changes: 0 additions & 8 deletions ...om/observeinc/observe-agent/components/processors/observek8sattributesprocessor/config.go
View file

This file was deleted.

5 changes: 0 additions & 5 deletions ...b.com/observeinc/observe-agent/components/processors/observek8sattributesprocessor/doc.go
View file

This file was deleted.

43 changes: 0 additions & 43 deletions ...m/observeinc/observe-agent/components/processors/observek8sattributesprocessor/factory.go
View file

This file was deleted.

17 changes: 0 additions & 17 deletions ...inc/observe-agent/components/processors/observek8sattributesprocessor/generated_status.go
View file

This file was deleted.

7 changes: 0 additions & 7 deletions ...bserveinc/observe-agent/components/processors/observek8sattributesprocessor/metadata.yaml
View file

This file was deleted.

Loading

0 comments on commit 17414a9

Please sign in to comment.