Skip to content

Commit

Permalink
[exporter/parquet] Deprecate Parquet Exporter (#27290)
Browse files Browse the repository at this point in the history
**Description:**
Deprecate Parquet exporter before removing it altogether.

**Link to tracking Issue:**
#27285
  • Loading branch information
atoulme authored Oct 3, 2023
1 parent 9f95743 commit 949f3e6
Show file tree
Hide file tree
Showing 15 changed files with 47 additions and 31 deletions.
27 changes: 27 additions & 0 deletions .chloggen/deprecate-parquet.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: breaking

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: parquetexporter

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Deprecate the Parquet Exporter, it will be removed in the next release.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [27284]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []
3 changes: 0 additions & 3 deletions cmd/configschema/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ require (
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/logzioexporter v0.86.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/lokiexporter v0.86.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/mezmoexporter v0.86.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/parquetexporter v0.86.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/prometheusremotewriteexporter v0.86.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/pulsarexporter v0.86.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/sapmexporter v0.86.0 // indirect
Expand Down Expand Up @@ -791,8 +790,6 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/exporter/mezmo

replace github.com/open-telemetry/opentelemetry-collector-contrib/exporter/opencensusexporter => ../../exporter/opencensusexporter

replace github.com/open-telemetry/opentelemetry-collector-contrib/exporter/parquetexporter => ../../exporter/parquetexporter

replace github.com/open-telemetry/opentelemetry-collector-contrib/exporter/prometheusexporter => ../../exporter/prometheusexporter

replace github.com/open-telemetry/opentelemetry-collector-contrib/exporter/prometheusremotewriteexporter => ../../exporter/prometheusremotewriteexporter
Expand Down
2 changes: 0 additions & 2 deletions cmd/otelcontribcol/builder-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ exporters:
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/exporter/lokiexporter v0.86.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/exporter/mezmoexporter v0.86.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/exporter/opencensusexporter v0.86.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/exporter/parquetexporter v0.86.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/exporter/prometheusexporter v0.86.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/exporter/prometheusremotewriteexporter v0.86.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/exporter/pulsarexporter v0.86.0
Expand Down Expand Up @@ -393,7 +392,6 @@ replaces:
- github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sshcheckreceiver => ../../receiver/sshcheckreceiver
- github.com/open-telemetry/opentelemetry-collector-contrib/receiver/datadogreceiver => ../../receiver/datadogreceiver
- github.com/open-telemetry/opentelemetry-collector-contrib/receiver/chronyreceiver => ../../receiver/chronyreceiver
- github.com/open-telemetry/opentelemetry-collector-contrib/exporter/parquetexporter => ../../exporter/parquetexporter
- github.com/open-telemetry/opentelemetry-collector-contrib/extension/observer/ecstaskobserver => ../../extension/observer/ecstaskobserver
- github.com/open-telemetry/opentelemetry-collector-contrib/receiver/lokireceiver => ../../receiver/lokireceiver
- github.com/open-telemetry/opentelemetry-collector-contrib/receiver/filestatsreceiver => ../../receiver/filestatsreceiver
Expand Down
2 changes: 0 additions & 2 deletions cmd/otelcontribcol/components.go

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

10 changes: 10 additions & 0 deletions cmd/otelcontribcol/distribution_metadata_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,27 @@ func TestComponentsArePresent(t *testing.T) {
return
}
inDevelopment := true
deprecated := true
for stability, pipelines := range m.Status.Stability {
if stability != "development" && len(pipelines) > 0 {
inDevelopment = false
break
}
if stability != "deprecated" && len(pipelines) > 0 {
deprecated = false
break
}
}

if inDevelopment {
tt.Skip("component in development, skipping", metadataComponent)
return
}

if deprecated {
tt.Skip("component deprecated, skipping", metadataComponent)
return
}
switch m.Status.Class {
case "connector":
assert.NotNil(tt, components.Connectors[component.Type(m.Type)], "missing connector: %s", m.Type)
Expand Down
10 changes: 0 additions & 10 deletions cmd/otelcontribcol/exporters_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ import (
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/lokiexporter"
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/mezmoexporter"
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/opencensusexporter"
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/parquetexporter"
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/prometheusexporter"
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/pulsarexporter"
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/sapmexporter"
Expand Down Expand Up @@ -137,15 +136,6 @@ func TestDefaultExporters(t *testing.T) {
return cfg
},
},
{
exporter: "parquet",
getConfigFn: func() component.Config {
cfg := expFactories["parquet"].CreateDefaultConfig().(*parquetexporter.Config)
cfg.Path = t.TempDir()
return cfg
},
skipLifecycle: true, // Causes race detector to fail
},
{
exporter: "prometheus",
getConfigFn: func() component.Config {
Expand Down
3 changes: 0 additions & 3 deletions cmd/otelcontribcol/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ require (
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/lokiexporter v0.86.0
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/mezmoexporter v0.86.0
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/opencensusexporter v0.86.0
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/parquetexporter v0.86.0
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/prometheusexporter v0.86.0
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/prometheusremotewriteexporter v0.86.0
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/pulsarexporter v0.86.0
Expand Down Expand Up @@ -1087,8 +1086,6 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/datad

replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/chronyreceiver => ../../receiver/chronyreceiver

replace github.com/open-telemetry/opentelemetry-collector-contrib/exporter/parquetexporter => ../../exporter/parquetexporter

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

replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/lokireceiver => ../../receiver/lokireceiver
Expand Down
4 changes: 2 additions & 2 deletions exporter/parquetexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
<!-- status autogenerated section -->
| Status | |
| ------------- |-----------|
| Stability | [development]: traces, metrics, logs |
| Stability | [deprecated]: traces, metrics, logs |
| Distributions | [contrib] |
| Issues | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aopen%20label%3Aexporter%2Fparquet%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Aexporter%2Fparquet) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Aexporter%2Fparquet%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Aexporter%2Fparquet) |
| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner) | [@atoulme](https://www.github.com/atoulme) |

[development]: https://github.com/open-telemetry/opentelemetry-collector#development
[deprecated]: https://github.com/open-telemetry/opentelemetry-collector#deprecated
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

Expand Down
2 changes: 2 additions & 0 deletions exporter/parquetexporter/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@
//go:generate mdatagen metadata.yaml

// Package parquetexporter implements an exporter that writes data to Parquet files.
//
// Deprecated: this component is no longer developed and will be removed in the next release.
package parquetexporter // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/parquetexporter"
1 change: 1 addition & 0 deletions exporter/parquetexporter/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ type Config struct {
}

// NewFactory creates a factory for the Parquet exporter.
// Deprecated: this exporter is no longer supported and will be removed in the next version.
func NewFactory() exporter.Factory {
return exporter.NewFactory(
metadata.Type,
Expand Down
1 change: 1 addition & 0 deletions exporter/parquetexporter/go.mod
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// Deprecated: this component is no longer developed and will be removed in the next release.
module github.com/open-telemetry/opentelemetry-collector-contrib/exporter/parquetexporter

go 1.20
Expand Down

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

2 changes: 1 addition & 1 deletion exporter/parquetexporter/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ type: parquet
status:
class: exporter
stability:
development: [traces, metrics, logs]
deprecated: [traces, metrics, logs]
distributions: [contrib]
codeowners:
active: [atoulme]
3 changes: 0 additions & 3 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ require (
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/lokiexporter v0.86.0
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/mezmoexporter v0.86.0
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/opencensusexporter v0.86.0
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/parquetexporter v0.86.0
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/prometheusexporter v0.86.0
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/prometheusremotewriteexporter v0.86.0
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/pulsarexporter v0.86.0
Expand Down Expand Up @@ -790,8 +789,6 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/exporter/mezmo

replace github.com/open-telemetry/opentelemetry-collector-contrib/exporter/opencensusexporter => ./exporter/opencensusexporter

replace github.com/open-telemetry/opentelemetry-collector-contrib/exporter/parquetexporter => ./exporter/parquetexporter

replace github.com/open-telemetry/opentelemetry-collector-contrib/exporter/prometheusexporter => ./exporter/prometheusexporter

replace github.com/open-telemetry/opentelemetry-collector-contrib/exporter/prometheusremotewriteexporter => ./exporter/prometheusremotewriteexporter
Expand Down
2 changes: 0 additions & 2 deletions internal/components/components.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ import (
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/lokiexporter"
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/mezmoexporter"
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/opencensusexporter"
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/parquetexporter"
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/prometheusexporter"
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/prometheusremotewriteexporter"
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/pulsarexporter"
Expand Down Expand Up @@ -340,7 +339,6 @@ func Components() (otelcol.Factories, error) {
opencensusexporter.NewFactory(),
otlpexporter.NewFactory(),
otlphttpexporter.NewFactory(),
parquetexporter.NewFactory(),
prometheusexporter.NewFactory(),
prometheusremotewriteexporter.NewFactory(),
pulsarexporter.NewFactory(),
Expand Down

0 comments on commit 949f3e6

Please sign in to comment.