Skip to content

Commit 0dc450f

Browse files
authored
chore(sinks): mark VectorSink::from_event_sink as deprecated (vectordotdev#17649)
This will help steer contributors away from writing new sinks in the deprecated fashion. See vectordotdev#9261 for more context. <!-- **Your PR title must conform to the conventional commit spec!** <type>(<scope>)!: <description> * `type` = chore, enhancement, feat, fix, docs * `!` = OPTIONAL: signals a breaking change * `scope` = Optional when `type` is "chore" or "docs", available scopes https://github.com/vectordotdev/vector/blob/master/.github/semantic.yml#L20 * `description` = short description of the change Examples: * enhancement(file source): Add `sort` option to sort discovered files * feat(new source): Initial `statsd` source * fix(file source): Fix a bug discovering new files * chore(external docs): Clarify `batch_size` option -->
1 parent a324a07 commit 0dc450f

File tree

20 files changed

+26
-0
lines changed

20 files changed

+26
-0
lines changed

lib/vector-core/src/sink.rs

+6
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,12 @@ impl VectorSink {
6161
}
6262

6363
/// Converts an event sink into a `VectorSink`
64+
///
65+
/// Deprecated in favor of `VectorSink::from_event_streamsink`. See [vector/9261]
66+
/// for more info.
67+
///
68+
/// [vector/9261]: https://github.com/vectordotdev/vector/issues/9261
69+
#[deprecated]
6470
pub fn from_event_sink(sink: impl Sink<Event, Error = ()> + Send + Unpin + 'static) -> Self {
6571
VectorSink::Sink(Box::new(EventSink::new(sink)))
6672
}

src/config/unit_test/unit_test_components.rs

+1
Original file line numberDiff line numberDiff line change
@@ -302,6 +302,7 @@ impl SinkConfig for UnitTestStreamSinkConfig {
302302
let sink = self.sink.lock().await.take().unwrap();
303303
let healthcheck = future::ok(()).boxed();
304304

305+
#[allow(deprecated)]
305306
Ok((VectorSink::from_event_sink(sink), healthcheck))
306307
}
307308

src/sinks/appsignal/mod.rs

+1
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,7 @@ impl SinkConfig for AppsignalSinkConfig {
136136
)
137137
.boxed();
138138

139+
#[allow(deprecated)]
139140
Ok((super::VectorSink::from_event_sink(sink), healthcheck))
140141
}
141142

src/sinks/aws_cloudwatch_metrics/mod.rs

+1
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,7 @@ impl CloudWatchMetricsSvc {
252252
})
253253
});
254254

255+
#[allow(deprecated)]
255256
Ok(VectorSink::from_event_sink(sink))
256257
}
257258

src/sinks/azure_monitor_logs.rs

+2
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,7 @@ impl SinkConfig for AzureMonitorLogsConfig {
204204
)
205205
.sink_map_err(|error| error!(message = "Fatal azure_monitor_logs sink error.", %error));
206206

207+
#[allow(deprecated)]
207208
Ok((VectorSink::from_event_sink(sink), healthcheck))
208209
}
209210

@@ -471,6 +472,7 @@ mod tests {
471472
.sink_map_err(|error| error!(message = "Fatal azure_monitor_logs sink error.", %error));
472473

473474
let event = Event::Log(LogEvent::from("simple message"));
475+
#[allow(deprecated)]
474476
run_and_assert_sink_compliance(
475477
VectorSink::from_event_sink(sink),
476478
stream::once(ready(event)),

src/sinks/clickhouse/http_sink.rs

+1
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ pub(crate) async fn build_http_sink(
4747

4848
let healthcheck = healthcheck(client, config).boxed();
4949

50+
#[allow(deprecated)]
5051
Ok((VectorSink::from_event_sink(sink), healthcheck))
5152
}
5253

src/sinks/gcp/pubsub.rs

+1
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@ impl SinkConfig for PubsubConfig {
135135
)
136136
.sink_map_err(|error| error!(message = "Fatal gcp_pubsub sink error.", %error));
137137

138+
#[allow(deprecated)]
138139
Ok((VectorSink::from_event_sink(sink), healthcheck))
139140
}
140141

src/sinks/gcp/stackdriver_logs.rs

+1
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,7 @@ impl SinkConfig for StackdriverConfig {
237237
)
238238
.sink_map_err(|error| error!(message = "Fatal gcp_stackdriver_logs sink error.", %error));
239239

240+
#[allow(deprecated)]
240241
Ok((VectorSink::from_event_sink(sink), healthcheck))
241242
}
242243

src/sinks/gcp/stackdriver_metrics.rs

+1
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,7 @@ impl SinkConfig for StackdriverConfig {
126126
|error| error!(message = "Fatal gcp_stackdriver_metrics sink error.", %error),
127127
);
128128

129+
#[allow(deprecated)]
129130
Ok((VectorSink::from_event_sink(sink), healthcheck))
130131
}
131132

src/sinks/honeycomb.rs

+1
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ impl SinkConfig for HoneycombConfig {
108108

109109
let healthcheck = healthcheck(self.clone(), client).boxed();
110110

111+
#[allow(deprecated)]
111112
Ok((super::VectorSink::from_event_sink(sink), healthcheck))
112113
}
113114

src/sinks/http.rs

+1
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,7 @@ impl SinkConfig for HttpSinkConfig {
251251
)
252252
.sink_map_err(|error| error!(message = "Fatal HTTP sink error.", %error));
253253

254+
#[allow(deprecated)]
254255
let sink = super::VectorSink::from_event_sink(sink);
255256

256257
Ok((sink, healthcheck))

src/sinks/influxdb/logs.rs

+1
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,7 @@ impl SinkConfig for InfluxDbLogsConfig {
232232
)
233233
.sink_map_err(|error| error!(message = "Fatal influxdb_logs sink error.", %error));
234234

235+
#[allow(deprecated)]
235236
Ok((VectorSink::from_event_sink(sink), healthcheck))
236237
}
237238

src/sinks/influxdb/metrics.rs

+1
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,7 @@ impl InfluxDbSvc {
193193
})
194194
.sink_map_err(|error| error!(message = "Fatal influxdb sink error.", %error));
195195

196+
#[allow(deprecated)]
196197
Ok(VectorSink::from_event_sink(sink))
197198
}
198199
}

src/sinks/mezmo.rs

+1
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@ impl SinkConfig for MezmoConfig {
175175

176176
let healthcheck = healthcheck(self.clone(), client).boxed();
177177

178+
#[allow(deprecated)]
178179
Ok((super::VectorSink::from_event_sink(sink), healthcheck))
179180
}
180181

src/sinks/prometheus/remote_write.rs

+1
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,7 @@ impl SinkConfig for RemoteWriteConfig {
261261
)
262262
};
263263

264+
#[allow(deprecated)]
264265
Ok((sinks::VectorSink::from_event_sink(sink), healthcheck))
265266
}
266267

src/sinks/redis.rs

+1
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,7 @@ impl RedisSinkConfig {
235235
})
236236
.sink_map_err(|error| error!(message = "Sink failed to flush.", %error));
237237

238+
#[allow(deprecated)]
238239
Ok(super::VectorSink::from_event_sink(sink))
239240
}
240241

src/sinks/sematext/metrics.rs

+1
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,7 @@ impl SematextMetricsService {
194194
})
195195
.sink_map_err(|error| error!(message = "Fatal sematext metrics sink error.", %error));
196196

197+
#[allow(deprecated)]
197198
Ok(VectorSink::from_event_sink(sink))
198199
}
199200
}

src/sinks/util/adaptive_concurrency/tests.rs

+1
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,7 @@ impl SinkConfig for TestConfig {
200200
);
201201
*self.controller_stats.lock().unwrap() = stats;
202202

203+
#[allow(deprecated)]
203204
Ok((VectorSink::from_event_sink(sink), healthcheck))
204205
}
205206

src/test_util/mock/sinks/error.rs

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ impl_generate_config_from_default!(ErrorSinkConfig);
3030
#[async_trait]
3131
impl SinkConfig for ErrorSinkConfig {
3232
async fn build(&self, _cx: SinkContext) -> crate::Result<(VectorSink, Healthcheck)> {
33+
#[allow(deprecated)]
3334
Ok((VectorSink::from_event_sink(ErrorSink), ok(()).boxed()))
3435
}
3536

src/test_util/mock/sinks/panic.rs

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ impl_generate_config_from_default!(PanicSinkConfig);
3030
#[async_trait]
3131
impl SinkConfig for PanicSinkConfig {
3232
async fn build(&self, _cx: SinkContext) -> crate::Result<(VectorSink, Healthcheck)> {
33+
#[allow(deprecated)]
3334
Ok((VectorSink::from_event_sink(PanicSink), ok(()).boxed()))
3435
}
3536

0 commit comments

Comments
 (0)