Skip to content

Add Fiddler receiver #38313

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.

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

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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 .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@ receiver/dockerstatsreceiver/ @open-telemetry
receiver/envoyalsreceiver/ @open-telemetry/collector-contrib-approvers @evan-bradley @zirain
receiver/expvarreceiver/ @open-telemetry/collector-contrib-approvers @jamesmoessis @MovieStoreGuy
receiver/faroreceiver/ @open-telemetry/collector-contrib-approvers @dehaansa @rlankfo @mar4uk
receiver/fiddlerreceiver/ @open-telemetry/collector-contrib-approvers @samikshan-fiddler
receiver/filelogreceiver/ @open-telemetry/collector-contrib-approvers @djaglowski @andrzej-stencel
receiver/filestatsreceiver/ @open-telemetry/collector-contrib-approvers @atoulme
receiver/flinkmetricsreceiver/ @open-telemetry/collector-contrib-approvers @JonathanWamsley
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,7 @@ body:
- receiver/envoyals
- receiver/expvar
- receiver/faro
- receiver/fiddler
- receiver/filelog
- receiver/filestats
- receiver/flinkmetrics
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@ body:
- receiver/envoyals
- receiver/expvar
- receiver/faro
- receiver/fiddler
- receiver/filelog
- receiver/filestats
- receiver/flinkmetrics
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/other.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@ body:
- receiver/envoyals
- receiver/expvar
- receiver/faro
- receiver/fiddler
- receiver/filelog
- receiver/filestats
- receiver/flinkmetrics
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/unmaintained.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,7 @@ body:
- receiver/envoyals
- receiver/expvar
- receiver/faro
- receiver/fiddler
- receiver/filelog
- receiver/filestats
- receiver/flinkmetrics
Expand Down
1 change: 1 addition & 0 deletions receiver/fiddlerreceiver/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
include ../../Makefile.common
35 changes: 35 additions & 0 deletions receiver/fiddlerreceiver/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Fiddler Receiver
<!-- status autogenerated section -->
| Status | |
| ------------- |-----------|
| Stability | [development]: metrics |
| Distributions | [] |
| Issues | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aopen%20label%3Areceiver%2Ffiddler%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Areceiver%2Ffiddler) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Areceiver%2Ffiddler%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Areceiver%2Ffiddler) |
| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner) | [@samikshan-fiddler](https://www.github.com/samikshan-fiddler) |

[development]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#development
<!-- end autogenerated section -->

The Fiddler receiver ingests metrics data from [Fiddler](https://docs.fiddler.ai/) and converts it into the OTLP metric format.

> **Warning**
> This receiver is currently in development. Functionality and configuration options may change.

## Configuration

The following settings are required:
- `endpoint`: The URL where Fiddler is deployed for your organization.
- `token`: Your authorization token from the Fiddler Settings page under the Credentials tab.

The following settings are optional:
- `interval`: The interval at which metrics data is pulled from Fiddler (default: `30m`).

### Example Configuration

```yaml
receivers:
fiddlerreceiver:
endpoint: https://api.fiddler.ai
token: "your_authorization_token"
interval: "30m"
```
38 changes: 38 additions & 0 deletions receiver/fiddlerreceiver/config.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
package fiddlerreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/fiddlerreceiver"

import (
"fmt"
"time"
)

type Config struct {
Endpoint string `mapstructure:"endpoint"`
Token string `mapstructure:"token"`
Interval string `mapstructure:"interval"`
}

func (cfg *Config) Validate() error {
if cfg.Endpoint == "" {
return fmt.Errorf("endpoint must be specified")
}

if cfg.Token == "" {
return fmt.Errorf("token must be specified")
}

if cfg.Interval == "" {
cfg.Interval = defaultInterval
return nil
}

interval, err := time.ParseDuration(cfg.Interval)
if err != nil {
return fmt.Errorf("invalid interval: %v", err)
}

if interval.Minutes() < 5 {
return fmt.Errorf("interval must be at least 5 minutes")
}

return nil
}
20 changes: 20 additions & 0 deletions receiver/fiddlerreceiver/config_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

package fiddlerreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/fiddlerreceiver"

import (
"testing"

"github.com/stretchr/testify/assert"
"go.opentelemetry.io/collector/component/componenttest"
"go.opentelemetry.io/collector/confmap"
)

func TestCreateDefaultConfig(t *testing.T) {
factory := NewFactory()
cfg := factory.CreateDefaultConfig()
assert.NotNil(t, cfg, "failed to create default config")
assert.NoError(t, confmap.New().Unmarshal(&cfg))
assert.NoError(t, componenttest.CheckConfigStruct(cfg))
}
6 changes: 6 additions & 0 deletions receiver/fiddlerreceiver/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

//go:generate mdatagen metadata.yaml

package fiddlerreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/fiddlerreceiver"
41 changes: 41 additions & 0 deletions receiver/fiddlerreceiver/factory.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
package fiddlerreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/fiddlerreceiver"

import (
"context"

"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/consumer"
"go.opentelemetry.io/collector/receiver"
)

var (
typeStr = component.MustNewType("fiddler")
)

const (
defaultInterval = "30m"
)

// NewFactory creates a factory for Fiddler receiver.
func NewFactory() receiver.Factory {
return receiver.NewFactory(
typeStr,
createDefaultConfig,
receiver.WithMetrics(createMetricsReceiver, component.StabilityLevelDevelopment))
}

func createDefaultConfig() component.Config {
return &Config{
Interval: defaultInterval,
}
}

func createMetricsReceiver(
_ context.Context,
params receiver.Settings,
baseCfg component.Config,
consumer consumer.Metrics,
) (receiver.Metrics, error) {
cfg := baseCfg.(*Config)
return newFiddlerReceiver(cfg, consumer), nil
}
43 changes: 43 additions & 0 deletions receiver/fiddlerreceiver/factory_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

package fiddlerreceiver

import (
"context"
"testing"

"github.com/stretchr/testify/assert"
"go.opentelemetry.io/collector/component/componenttest"
"go.opentelemetry.io/collector/consumer/consumertest"
"go.opentelemetry.io/collector/receiver/receivertest"
)

func TestFactoryCreateDefaultConfig(t *testing.T) {
factory := NewFactory()
cfg := factory.CreateDefaultConfig()
assert.NotNil(t, cfg, "failed to create default configuration")
assert.NoError(t, componenttest.CheckConfigStruct(cfg))

fiddlerCfg, ok := cfg.(*Config)
assert.True(t, ok, "configuration is not of type Config")
assert.Equal(t, defaultInterval, fiddlerCfg.Interval)
}

func TestCreateReceiver_Factory(t *testing.T) {
factory := NewFactory()
cfg := factory.CreateDefaultConfig().(*Config)
cfg.Endpoint = "https://api.fiddler.ai"
cfg.Token = "test-token"

consumer := consumertest.NewNop()
receiver, err := factory.CreateMetrics(
context.Background(),
receivertest.NewNopSettings(factory.Type()),
cfg,
consumer,
)

assert.NoError(t, err)
assert.NotNil(t, receiver)
}
71 changes: 71 additions & 0 deletions receiver/fiddlerreceiver/generated_component_test.go

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

12 changes: 12 additions & 0 deletions receiver/fiddlerreceiver/generated_package_test.go

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

55 changes: 55 additions & 0 deletions receiver/fiddlerreceiver/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
module github.com/open-telemetry/opentelemetry-collector-contrib/receiver/fiddlerreceiver

go 1.23.0

require (
github.com/stretchr/testify v1.10.0
go.opentelemetry.io/collector/component v0.120.0
go.opentelemetry.io/collector/component/componenttest v0.120.0
go.opentelemetry.io/collector/confmap v1.26.0
go.opentelemetry.io/collector/consumer v1.26.0
go.opentelemetry.io/collector/consumer/consumertest v0.120.0
go.opentelemetry.io/collector/receiver v0.120.0
go.opentelemetry.io/collector/receiver/receivertest v0.120.0
go.uber.org/goleak v1.3.0
)

require (
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/go-logr/logr v1.4.2 // indirect
github.com/go-logr/stdr v1.2.2 // indirect
github.com/go-viper/mapstructure/v2 v2.2.1 // indirect
github.com/gogo/protobuf v1.3.2 // indirect
github.com/google/go-cmp v0.7.0 // indirect
github.com/google/uuid v1.6.0 // indirect
github.com/json-iterator/go v1.1.12 // indirect
github.com/knadh/koanf/maps v0.1.1 // indirect
github.com/knadh/koanf/providers/confmap v0.1.0 // indirect
github.com/knadh/koanf/v2 v2.1.2 // indirect
github.com/mitchellh/copystructure v1.2.0 // indirect
github.com/mitchellh/reflectwalk v1.0.2 // indirect
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
github.com/modern-go/reflect2 v1.0.2 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
go.opentelemetry.io/auto/sdk v1.1.0 // indirect
go.opentelemetry.io/collector/consumer/consumererror v0.120.0 // indirect
go.opentelemetry.io/collector/consumer/xconsumer v0.120.0 // indirect
go.opentelemetry.io/collector/pdata v1.26.0 // indirect
go.opentelemetry.io/collector/pdata/pprofile v0.120.0 // indirect
go.opentelemetry.io/collector/pipeline v0.120.0 // indirect
go.opentelemetry.io/collector/receiver/xreceiver v0.120.0 // indirect
go.opentelemetry.io/otel v1.34.0 // indirect
go.opentelemetry.io/otel/metric v1.34.0 // indirect
go.opentelemetry.io/otel/sdk v1.34.0 // indirect
go.opentelemetry.io/otel/sdk/metric v1.34.0 // indirect
go.opentelemetry.io/otel/trace v1.34.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
go.uber.org/zap v1.27.0 // indirect
golang.org/x/net v0.33.0 // indirect
golang.org/x/sys v0.30.0 // indirect
golang.org/x/text v0.21.0 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20241202173237-19429a94021a // indirect
google.golang.org/grpc v1.70.0 // indirect
google.golang.org/protobuf v1.36.5 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
Loading
Loading