Skip to main content

pipeline/
options.rs

1// Copyright 2023 Greptime Team
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::time::Duration;
16
17use serde::{Deserialize, Serialize};
18
19#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
20#[serde(default)]
21pub struct PipelineOptions {
22    /// Time to live of the frontend-local pipeline cache. A pipeline created or
23    /// deleted on another frontend takes effect on this one after at most this
24    /// duration. Default: "10s".
25    #[serde(with = "humantime_serde")]
26    pub cache_ttl: Duration,
27    /// Allows VRL programs to access the server environment, filesystem, hostname,
28    /// local timezone, network, and logs. Enable only for trusted pipeline authors.
29    /// Defaults to false. Changes require a restart.
30    pub allow_vrl_host_access: bool,
31    /// Default for the HTTP log ingestion and pipeline dry-run `ignore_errors` parameter.
32    /// Explicit request values override this setting. Malformed input may be discarded,
33    /// and invalid custom timestamps in identity ingestion fall back to server time.
34    /// Pipeline execution errors are controlled separately by `skip_error`.
35    /// Defaults to false. Changes require a restart.
36    pub ignore_errors: bool,
37}
38
39impl Default for PipelineOptions {
40    fn default() -> Self {
41        Self {
42            cache_ttl: Duration::from_secs(10),
43            allow_vrl_host_access: false,
44            ignore_errors: false,
45        }
46    }
47}