Skip to content
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

feat: update pipeline header name to x-greptime-pipeline-name #5710

Merged
merged 3 commits into from
Mar 18, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
45 changes: 27 additions & 18 deletions src/servers/src/http/extractor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ use pipeline::{GreptimePipelineParams, SelectInfo};
use crate::http::header::constants::{
GREPTIME_LOG_EXTRACT_KEYS_HEADER_NAME, GREPTIME_LOG_PIPELINE_NAME_HEADER_NAME,
GREPTIME_LOG_PIPELINE_VERSION_HEADER_NAME, GREPTIME_LOG_TABLE_NAME_HEADER_NAME,
GREPTIME_PIPELINE_PARAMS_HEADER, GREPTIME_TRACE_TABLE_NAME_HEADER_NAME,
GREPTIME_PIPELINE_NAME_HEADER_NAME, GREPTIME_PIPELINE_PARAMS_HEADER,
GREPTIME_PIPELINE_VERSION_HEADER_NAME, GREPTIME_TRACE_TABLE_NAME_HEADER_NAME,
};

/// Axum extractor for optional target log table name from HTTP header
Expand All @@ -38,7 +39,9 @@ where

async fn from_request_parts(parts: &mut Parts, _state: &S) -> Result<Self, Self::Rejection> {
let headers = &parts.headers;
string_value_from_header(headers, GREPTIME_LOG_TABLE_NAME_HEADER_NAME).map(LogTableName)
string_value_from_header(headers, GREPTIME_LOG_TABLE_NAME_HEADER_NAME)
.transpose()
.map(LogTableName)
}
}

Expand All @@ -54,7 +57,9 @@ where

async fn from_request_parts(parts: &mut Parts, _state: &S) -> Result<Self, Self::Rejection> {
let headers = &parts.headers;
string_value_from_header(headers, GREPTIME_TRACE_TABLE_NAME_HEADER_NAME).map(TraceTableName)
string_value_from_header(headers, GREPTIME_TRACE_TABLE_NAME_HEADER_NAME)
.transpose()
.map(TraceTableName)
}
}

Expand All @@ -71,7 +76,8 @@ where

async fn from_request_parts(parts: &mut Parts, _state: &S) -> Result<Self, Self::Rejection> {
let select =
string_value_from_header(&parts.headers, GREPTIME_LOG_EXTRACT_KEYS_HEADER_NAME)?;
string_value_from_header(&parts.headers, GREPTIME_LOG_EXTRACT_KEYS_HEADER_NAME)
.transpose()?;

match select {
Some(name) => {
Expand Down Expand Up @@ -103,11 +109,17 @@ where
async fn from_request_parts(parts: &mut Parts, _state: &S) -> Result<Self, Self::Rejection> {
let headers = &parts.headers;
let pipeline_name =
string_value_from_header(headers, GREPTIME_LOG_PIPELINE_NAME_HEADER_NAME)?;
string_value_from_header(headers, GREPTIME_LOG_PIPELINE_NAME_HEADER_NAME)
.or_else(|| string_value_from_header(headers, GREPTIME_PIPELINE_NAME_HEADER_NAME))
.transpose()?;
let pipeline_version =
string_value_from_header(headers, GREPTIME_LOG_PIPELINE_VERSION_HEADER_NAME)?;
string_value_from_header(headers, GREPTIME_LOG_PIPELINE_VERSION_HEADER_NAME)
.or_else(|| {
string_value_from_header(headers, GREPTIME_PIPELINE_VERSION_HEADER_NAME)
})
.transpose()?;
let pipeline_parameters =
string_value_from_header(headers, GREPTIME_PIPELINE_PARAMS_HEADER)?;
string_value_from_header(headers, GREPTIME_PIPELINE_PARAMS_HEADER).transpose()?;

Ok(PipelineInfo {
pipeline_name,
Expand All @@ -121,16 +133,13 @@ where
fn string_value_from_header(
headers: &HeaderMap,
header_key: &str,
) -> Result<Option<String>, (StatusCode, String)> {
headers
.get(header_key)
.map(|value| {
String::from_utf8(value.as_bytes().to_vec()).map_err(|_| {
(
StatusCode::BAD_REQUEST,
format!("`{}` header is not valid UTF-8 string type.", header_key),
)
})
) -> Option<Result<String, (StatusCode, String)>> {
headers.get(header_key).map(|value| {
String::from_utf8(value.as_bytes().to_vec()).map_err(|_| {
(
StatusCode::BAD_REQUEST,
format!("`{}` header is not valid UTF-8 string type.", header_key),
)
})
.transpose()
})
}
7 changes: 7 additions & 0 deletions src/servers/src/http/header.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,15 @@ pub mod constants {
pub const GREPTIME_DB_HEADER_NAME: &str = "x-greptime-db-name";
pub const GREPTIME_TIMEZONE_HEADER_NAME: &str = "x-greptime-timezone";
pub const GREPTIME_DB_HEADER_ERROR_CODE: &str = common_error::GREPTIME_DB_HEADER_ERROR_CODE;

// Deprecated: pipeline is also used with trace, so we remove log from it.
pub const GREPTIME_LOG_PIPELINE_NAME_HEADER_NAME: &str = "x-greptime-log-pipeline-name";
pub const GREPTIME_LOG_PIPELINE_VERSION_HEADER_NAME: &str = "x-greptime-log-pipeline-version";

// More generic pipeline header name
pub const GREPTIME_PIPELINE_NAME_HEADER_NAME: &str = "x-greptime-pipeline-name";
pub const GREPTIME_PIPELINE_VERSION_HEADER_NAME: &str = "x-greptime-pipeline-version";

pub const GREPTIME_LOG_TABLE_NAME_HEADER_NAME: &str = "x-greptime-log-table-name";
pub const GREPTIME_LOG_EXTRACT_KEYS_HEADER_NAME: &str = "x-greptime-log-extract-keys";
pub const GREPTIME_TRACE_TABLE_NAME_HEADER_NAME: &str = "x-greptime-trace-table-name";
Expand Down
4 changes: 2 additions & 2 deletions tests-integration/tests/http.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2181,7 +2181,7 @@ pub async fn test_otlp_traces_v1(store_type: StorageType) {
HeaderValue::from_static("application/x-protobuf"),
),
(
HeaderName::from_static("x-greptime-log-pipeline-name"),
HeaderName::from_static("x-greptime-pipeline-name"),
HeaderValue::from_static(TRACE_V1),
),
(
Expand Down Expand Up @@ -2222,7 +2222,7 @@ pub async fn test_otlp_traces_v1(store_type: StorageType) {
HeaderValue::from_static("application/x-protobuf"),
),
(
HeaderName::from_static("x-greptime-log-pipeline-name"),
HeaderName::from_static("x-greptime-pipeline-name"),
HeaderValue::from_static(TRACE_V1),
),
(
Expand Down
Loading