com.microsoft.applicationinsights.web.extensibility.initializers.WebSyntheticRequestTelemetryInitializer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of applicationinsights-web Show documentation
This is the web module of Microsoft Application Insights Java SDK
There is a newer version: 3.6.2
Show newest version
/*
 * AppInsights-Java
 * Copyright (c) Microsoft Corporation
 * All rights reserved.
 *
 * MIT License
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this
 * software and associated documentation files (the ""Software""), to deal in the Software
 * without restriction, including without limitation the rights to use, copy, modify, merge,
 * publish, distribute, sublicense, and/or sell copies of the Software, and to permit
 * persons to whom the Software is furnished to do so, subject to the following conditions:
 * The above copyright notice and this permission notice shall be included in all copies or
 * substantial portions of the Software.
 * THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 * PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
 * FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

package com.microsoft.applicationinsights.web.extensibility.initializers;

import java.util.concurrent.ConcurrentMap;

import javax.servlet.http.HttpServletRequest;

import com.microsoft.applicationinsights.telemetry.Telemetry;
import com.microsoft.applicationinsights.web.internal.RequestTelemetryContext;
import com.microsoft.applicationinsights.web.internal.ThreadContext;

import com.google.common.base.Strings;

/**
 * Created by gupele on 8/17/2015.
 */
public class WebSyntheticRequestTelemetryInitializer extends WebTelemetryInitializerBase {
    final static String SYNTHETIC_SOURCE_NAME = "Application Insights Availability Monitoring";
    final static String SYNTHETIC_TEST_RUN_ID = "SyntheticTest-RunId";
    final static String SYNTHETIC_TEST_LOCATION = "SyntheticTest-Location";
    final static String SYNTHETIC_TEST_SOURCE = "SyntheticTest-Source";
    final static String SYNTHETIC_TEST_TEST_NAME = "SyntheticTest-TestName";
    final static String SYNTHETIC_TEST_SESSION_ID = "SyntheticTest-SessionId";
    final static String SYNTHETIC_TEST_USER_ID = "SyntheticTest-UserId";
    final static String SYNTHETIC_TEST_OPERATION_ID = "SyntheticTest-OperationId";

    @Override
    protected void onInitializeTelemetry(Telemetry telemetry) {
        RequestTelemetryContext telemetryContext = ThreadContext.getRequestTelemetryContext();

        if (telemetryContext == null) {
            return;
        }

        HttpServletRequest request = telemetryContext.getHttpServletRequest();
        if (request == null) {
            return;
        }

        String syntheticSourceHeader = request.getHeader(SYNTHETIC_TEST_SOURCE);
        if (Strings.isNullOrEmpty(syntheticSourceHeader)) {
            handlePossibleGSMSyntheticRequest(telemetry, request);
        } else {
            handleCommonSyntheticRequest(syntheticSourceHeader, telemetry, request);
        }
    }

    private void handlePossibleGSMSyntheticRequest(Telemetry telemetry, HttpServletRequest request) {
        String gsmSyntheticTestRunId = request.getHeader(SYNTHETIC_TEST_RUN_ID);
        if (Strings.isNullOrEmpty(gsmSyntheticTestRunId)) {
            return;
        }

        String syntheticSource = telemetry.getContext().getOperation().getSyntheticSource();
        if (Strings.isNullOrEmpty(syntheticSource)) {
            telemetry.getContext().getOperation().setSyntheticSource(SYNTHETIC_SOURCE_NAME);
        }

        String sessionId = telemetry.getContext().getSession().getId();
        if (Strings.isNullOrEmpty(sessionId)) {
            telemetry.getContext().getSession().setId(gsmSyntheticTestRunId);
        }

        String userId = telemetry.getContext().getUser().getId();
        if (Strings.isNullOrEmpty(userId)) {
            String header = request.getHeader(SYNTHETIC_TEST_LOCATION);
            telemetry.getContext().getUser().setId(header);
        }
    }

    private void handleCommonSyntheticRequest(String syntheticSourceHeader, Telemetry telemetry, HttpServletRequest request) {
        String syntheticSource = telemetry.getContext().getOperation().getSyntheticSource();
        if (Strings.isNullOrEmpty(syntheticSource)) {
            telemetry.getContext().getOperation().setSyntheticSource(syntheticSourceHeader);
        }

        String userId = telemetry.getContext().getUser().getId();
        if (Strings.isNullOrEmpty(userId)) {
            String header = request.getHeader(SYNTHETIC_TEST_USER_ID);
            telemetry.getContext().getUser().setId(header);
        }

        String sessionId = telemetry.getContext().getSession().getId();
        if (Strings.isNullOrEmpty(sessionId)) {
            String header = request.getHeader(SYNTHETIC_TEST_SESSION_ID);
            telemetry.getContext().getSession().setId(header);
        }

        String operationId = telemetry.getContext().getOperation().getId();
        if (Strings.isNullOrEmpty(operationId)) {
            String header = request.getHeader(SYNTHETIC_TEST_OPERATION_ID);
            telemetry.getContext().getOperation().setId(header);
        }

        putInProperties(telemetry, request, SYNTHETIC_TEST_TEST_NAME, SYNTHETIC_TEST_RUN_ID, SYNTHETIC_TEST_LOCATION);
    }

    private void putInProperties(Telemetry telemetry, HttpServletRequest request, String... headers) {
        ConcurrentMap properties = telemetry.getContext().getProperties();
        for (String header : headers) {
            String headerValue = request.getHeader(header);
            if (headerValue != null) {
                properties.put(header, headerValue);
            }
        }
    }
}