Skip to content

Add support for HTTP header x-correlation-id #195

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add support for HTTP header x-correlation-id #195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
74 changes: 34 additions & 40 deletions ...logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/request/HttpHeaders.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,64 +1,58 @@
package com.sap.hcp.cf.logging.common.request;

import static java.util.Arrays.asList;
import static java.util.Collections.unmodifiableList;
import com.sap.hcp.cf.logging.common.Defaults;
import com.sap.hcp.cf.logging.common.Fields;
import com.sap.hcp.cf.logging.common.LogContext;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import com.sap.hcp.cf.logging.common.Defaults;
import com.sap.hcp.cf.logging.common.Fields;
import com.sap.hcp.cf.logging.common.LogContext;
import static java.util.Arrays.asList;
import static java.util.Collections.unmodifiableList;

public enum HttpHeaders implements HttpHeader {
CONTENT_LENGTH("content-length"), //
CONTENT_TYPE("content-type"), //
REFERER("referer"), //
X_CUSTOM_HOST("x-custom-host", Fields.X_CUSTOM_HOST), //
X_FORWARDED_FOR("x-forwarded-for", Fields.X_FORWARDED_FOR), //
X_FORWARDED_HOST("x-forwarded-host", Fields.X_FORWARDED_HOST), //
X_FORWARDED_PROTO("x-forwarded-proto", Fields.X_FORWARDED_PROTO), //
X_SSL_CLIENT("x-ssl-client", Fields.X_SSL_CLIENT), //
X_SSL_CLIENT_VERIFY("x-ssl-client-verify", Fields.X_SSL_CLIENT_VERIFY), //
X_SSL_CLIENT_SUBJECT_DN("x-ssl-client-subject-dn",
Fields.X_SSL_CLIENT_SUBJECT_DN), //
X_SSL_CLIENT_SUBJECT_CN("x-ssl-client-subject-cn",
Fields.X_SSL_CLIENT_SUBJECT_CN), //
X_SSL_CLIENT_ISSUER_DN("x-ssl-client-issuer-dn",
Fields.X_SSL_CLIENT_ISSUER_DN), //
X_SSL_CLIENT_NOTBEFORE("x-ssl-client-notbefore",
Fields.X_SSL_CLIENT_NOTBEFORE), //
X_SSL_CLIENT_NOTAFTER("x-ssl-client-notafter",
Fields.X_SSL_CLIENT_NOTAFTER), //
X_SSL_CLIENT_SESSION_ID("x-ssl-client-session-id",
Fields.X_SSL_CLIENT_SESSION_ID), //
X_VCAP_REQUEST_ID("x-vcap-request-id", Fields.REQUEST_ID, true), //
CORRELATION_ID("X-CorrelationID", Fields.CORRELATION_ID, true,
X_VCAP_REQUEST_ID), //
W3C_TRACEPARENT("traceparent", Fields.W3C_TRACEPARENT, true),
SAP_PASSPORT("sap-passport", Fields.SAP_PASSPORT, true), //
TENANT_ID("tenantid", Fields.TENANT_ID, true); //

private HttpHeaders(String name) {
CONTENT_LENGTH("content-length"), //
CONTENT_TYPE("content-type"), //
REFERER("referer"), //
X_CUSTOM_HOST("x-custom-host", Fields.X_CUSTOM_HOST), //
X_FORWARDED_FOR("x-forwarded-for", Fields.X_FORWARDED_FOR), //
X_FORWARDED_HOST("x-forwarded-host", Fields.X_FORWARDED_HOST), //
X_FORWARDED_PROTO("x-forwarded-proto", Fields.X_FORWARDED_PROTO), //
X_SSL_CLIENT("x-ssl-client", Fields.X_SSL_CLIENT), //
X_SSL_CLIENT_VERIFY("x-ssl-client-verify", Fields.X_SSL_CLIENT_VERIFY), //
X_SSL_CLIENT_SUBJECT_DN("x-ssl-client-subject-dn", Fields.X_SSL_CLIENT_SUBJECT_DN), //
X_SSL_CLIENT_SUBJECT_CN("x-ssl-client-subject-cn", Fields.X_SSL_CLIENT_SUBJECT_CN), //
X_SSL_CLIENT_ISSUER_DN("x-ssl-client-issuer-dn", Fields.X_SSL_CLIENT_ISSUER_DN), //
X_SSL_CLIENT_NOTBEFORE("x-ssl-client-notbefore", Fields.X_SSL_CLIENT_NOTBEFORE), //
X_SSL_CLIENT_NOTAFTER("x-ssl-client-notafter", Fields.X_SSL_CLIENT_NOTAFTER), //
X_SSL_CLIENT_SESSION_ID("x-ssl-client-session-id", Fields.X_SSL_CLIENT_SESSION_ID), //
X_VCAP_REQUEST_ID("x-vcap-request-id", Fields.REQUEST_ID, true), //
X_CORRELATION_ID_ALTERNATIVE("x-correlation-id"), //
CORRELATION_ID("X-CorrelationID", Fields.CORRELATION_ID, true, X_CORRELATION_ID_ALTERNATIVE, X_VCAP_REQUEST_ID), //
W3C_TRACEPARENT("traceparent", Fields.W3C_TRACEPARENT, true),
SAP_PASSPORT("sap-passport", Fields.SAP_PASSPORT, true), //
TENANT_ID("tenantid", Fields.TENANT_ID, true); //

HttpHeaders(String name) {
this(name, null);
}

private HttpHeaders(String name, String field) {
HttpHeaders(String name, String field) {
this(name, field, false);
}

private HttpHeaders(String name, String field, boolean isPropagated, HttpHeaders... aliases) {
HttpHeaders(String name, String field, boolean isPropagated, HttpHeaders... aliases) {
this.name = name;
this.field = field;
this.isPropagated = isPropagated;
this.aliases = unmodifiableList(asList(aliases));
}

private String name;
private String field;
private boolean isPropagated;
private List<HttpHeader> aliases;
private final String name;
private final String field;
private final boolean isPropagated;
private final List<HttpHeader> aliases;

@Override
public boolean isPropagated() {
Expand Down
33 changes: 16 additions & 17 deletions ...ing-support-core/src/test/java/com/sap/hcp/cf/logging/common/request/HttpHeadersTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,13 @@
package com.sap.hcp.cf.logging.common.request;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.containsInAnyOrder;
import static org.hamcrest.Matchers.empty;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.nullValue;

import org.junit.Before;
import org.junit.Test;

import com.sap.hcp.cf.logging.common.Defaults;
import com.sap.hcp.cf.logging.common.Fields;
import com.sap.hcp.cf.logging.common.LogContext;
import org.junit.Before;
import org.junit.Test;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.*;

public class HttpHeadersTest {

Expand All @@ -24,14 +19,15 @@ public void resetLogContext() {

@Test
public void hasCorrectNumberOfTypes() throws Exception {
assertThat(HttpHeaders.values().length, is(equalTo(20)));
assertThat(HttpHeaders.values().length, is(equalTo(21)));
}

@Test
public void hasCorrectNames() throws Exception {
assertThat(HttpHeaders.CONTENT_LENGTH.getName(), is("content-length"));
assertThat(HttpHeaders.CONTENT_TYPE.getName(), is("content-type"));
assertThat(HttpHeaders.CORRELATION_ID.getName(), is("X-CorrelationID"));
assertThat(HttpHeaders.X_CORRELATION_ID_ALTERNATIVE.getName(), is("x-correlation-id"));
assertThat(HttpHeaders.REFERER.getName(), is("referer"));
assertThat(HttpHeaders.TENANT_ID.getName(), is("tenantid"));
assertThat(HttpHeaders.W3C_TRACEPARENT.getName(), is("traceparent"));
Expand All @@ -55,6 +51,7 @@ public void hasCorrectFields() throws Exception {
assertThat(HttpHeaders.CONTENT_LENGTH.getField(), is(nullValue()));
assertThat(HttpHeaders.CONTENT_TYPE.getField(), is(nullValue()));
assertThat(HttpHeaders.CORRELATION_ID.getField(), is(Fields.CORRELATION_ID));
assertThat(HttpHeaders.X_CORRELATION_ID_ALTERNATIVE.getField(), is(nullValue()));
assertThat(HttpHeaders.REFERER.getField(), is(nullValue()));
assertThat(HttpHeaders.TENANT_ID.getField(), is(Fields.TENANT_ID));
assertThat(HttpHeaders.W3C_TRACEPARENT.getField(), is(Fields.W3C_TRACEPARENT));
Expand Down Expand Up @@ -83,16 +80,18 @@ public void defaultFieldValueIsUnknownWithoutConfiguredField() throws Exception
@Test
public void defaultFieldValueIsNullForProgatedHeaders() throws Exception {
for (HttpHeader header: HttpHeaders.propagated()) {
assertThat("Default of field <" + header.getField() + "> from header <" + header.getName() +
"> should be null", header.getFieldValue(), is(nullValue()));
assertThat(
"Default of field <" + header.getField() + "> from header <" + header.getName() + "> should be null",
header.getFieldValue(), is(nullValue()));
}
}

@Test
public void hasCorrectAliases() throws Exception {
assertThat(HttpHeaders.CONTENT_LENGTH.getAliases(), is(empty()));
assertThat(HttpHeaders.CONTENT_TYPE.getAliases(), is(empty()));
assertThat(HttpHeaders.CORRELATION_ID.getAliases(), containsInAnyOrder(HttpHeaders.X_VCAP_REQUEST_ID));
assertThat(HttpHeaders.CORRELATION_ID.getAliases(),
containsInAnyOrder(HttpHeaders.X_CORRELATION_ID_ALTERNATIVE, HttpHeaders.X_VCAP_REQUEST_ID));
assertThat(HttpHeaders.REFERER.getAliases(), is(empty()));
assertThat(HttpHeaders.TENANT_ID.getAliases(), is(empty()));
assertThat(HttpHeaders.W3C_TRACEPARENT.getAliases(), is(empty()));
Expand All @@ -113,9 +112,9 @@ public void hasCorrectAliases() throws Exception {

@Test
public void propagatesCorrectHeaders() throws Exception {
assertThat(HttpHeaders.propagated(), containsInAnyOrder(HttpHeaders.CORRELATION_ID, HttpHeaders.SAP_PASSPORT,
HttpHeaders.TENANT_ID, HttpHeaders.W3C_TRACEPARENT,
HttpHeaders.X_VCAP_REQUEST_ID));
assertThat(HttpHeaders.propagated(),
containsInAnyOrder(HttpHeaders.CORRELATION_ID, HttpHeaders.SAP_PASSPORT, HttpHeaders.TENANT_ID,
HttpHeaders.W3C_TRACEPARENT, HttpHeaders.X_VCAP_REQUEST_ID));
}

}