org.apache.cxf.tracing.micrometer.jaxrs.JaxrsObservationDocumentation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cxf-integration-tracing-micrometer Show documentation
Apache CXF Observability using Micrometer Observation
There is a newer version: 4.1.0
Show newest version
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.cxf.tracing.micrometer.jaxrs;

import io.micrometer.common.docs.KeyName;
import io.micrometer.observation.Observation.Context;
import io.micrometer.observation.ObservationConvention;
import io.micrometer.observation.docs.ObservationDocumentation;

/**
 *
 */
enum JaxrsObservationDocumentation implements ObservationDocumentation {

    /**
     * Observation created when a request is sent out.
     */
    OUT_OBSERVATION {
        @Override
        public Class> getDefaultConvention() {
            return DefaultContainerRequestSenderObservationConvention.class;
        }

        @Override
        public KeyName[] getLowCardinalityKeyNames() {
            return CommonLowCardinalityKeys.values();
        }

        @Override
        public KeyName[] getHighCardinalityKeyNames() {
            return KeyName.merge(CommonHighCardinalityKeys.values(), ClientHighCardinalityKeys.values());
        }
    },

    /**
     * Observation created when a request is received.
     */
    IN_OBSERVATION {
        @Override
        public Class> getDefaultConvention() {
            return DefaultContainerRequestReceiverObservationConvention.class;
        }

        @Override
        public KeyName[] getLowCardinalityKeyNames() {
            return KeyName.merge(CommonLowCardinalityKeys.values(), ServerLowCardinalityKeys.values());
        }

        @Override
        public KeyName[] getHighCardinalityKeyNames() {
            return CommonHighCardinalityKeys.values();
        }

    };

    enum CommonLowCardinalityKeys implements KeyName {

        /**
         * HTTP request method.
         */
        HTTP_REQUEST_METHOD {
            @Override
            public String asString() {
                return "http.request.method";
            }
        },

        /**
         * HTTP response status code.
         */
        HTTP_RESPONSE_STATUS_CODE {
            @Override
            public boolean isRequired() {
                return false;
            }

            @Override
            public String asString() {
                return "http.response.status_code";
            }
        },

        /**
         * OSI Application Layer or non-OSI equivalent. The value SHOULD be normalized to lowercase.
         */
        NETWORK_PROTOCOL_NAME {
            @Override
            public String asString() {
                return "network.protocol.name";
            }
        },

        /**
         * Name of the local HTTP server that received the request.
         */
        SERVER_ADRESS {
            @Override
            public String asString() {
                return "server.address";
            }

        },

        /**
         * Port of the local HTTP server that received the request.
         */
        SERVER_PORT {
            @Override
            public String asString() {
                return "server.port";
            }

        },

        /**
         * The URI scheme component identifying the used protocol.
         */
        URL_SCHEME {
            @Override
            public String asString() {
                return "url.scheme";
            }
        }
    }

    enum ServerLowCardinalityKeys implements KeyName {
        /**
         * The matched route (path template in the format used by the respective server framework).
         */
        HTTP_ROUTE {
            @Override
            public boolean isRequired() {
                return false;
            }

            @Override
            public String asString() {
                return "http.route";
            }
        }
    }

    enum CommonHighCardinalityKeys implements KeyName {
        /**
         * The size of the request payload body in bytes. This is the number of bytes transferred 
         * excluding headers and is often, but not always, present as the Content-Length header. 
         * For requests using transport encoding, this should be the compressed size.
         */
        REQUEST_BODY_SIZE {
            @Override
            public boolean isRequired() {
                return false;
            }

            @Override
            public String asString() {
                return "http.request.body.size";
            }
        },

        /**
         * The size of the response payload body in bytes. This is the number of bytes 
         * transferred excluding headers and is often, but not always, present as the 
         * Content-Length header. For requests using transport encoding, this should be 
         * the compressed size.
         */
        RESPONSE_BODY_SIZE {
            @Override
            public boolean isRequired() {
                return false;
            }

            @Override
            public String asString() {
                return "http.response.body.size";
            }

        },

        /**
         * Value of the HTTP User-Agent header sent by the client.
         */
        USER_AGENT_ORIGINAL {
            @Override
            public boolean isRequired() {
                return false;
            }

            @Override
            public String asString() {
                return "user_agent.original";
            }

        }

    }

    enum ClientHighCardinalityKeys implements KeyName {
        /**
         * Absolute URL describing a network resource according to RFC3986
         */
        URL_FULL {
            @Override
            public String asString() {
                return "url.full";
            }
        }

    }
}