com.newrelic.agent.AgentLinkingMetadata Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of newrelic-agent Show documentation
Jar required to run with a java application to monitor performance.
The newest version!
/*
 *
 *  * Copyright 2022 New Relic Corporation. All rights reserved.
 *  * SPDX-License-Identifier: Apache-2.0
 *
 */

package com.newrelic.agent;

import com.newrelic.agent.config.AgentConfig;
import com.newrelic.agent.config.ConfigService;
import com.newrelic.agent.config.Hostname;
import com.newrelic.api.agent.TraceMetadata;

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.logging.Level;

/**
 * Utility class for providing agent linking metadata.
 * This metadata can be used to link events to specific traces, spans, hosts, and entities.
 */
public class AgentLinkingMetadata {
    public static final String ENTITY_TYPE_DEFAULT = "SERVICE";
    public static final String LOCALHOST = "localhost";
    // Agent linking metadata attributes
    public static final String TRACE_ID = "trace.id";
    public static final String SPAN_ID = "span.id";
    public static final String HOSTNAME = "hostname";
    public static final String ENTITY_GUID = "entity.guid";
    public static final String ENTITY_NAME = "entity.name";
    public static final String ENTITY_TYPE = "entity.type";

    /**
     * Get a map of all agent linking metadata.
     *
     * @param traceMetadata TraceMetadataImpl instance to get spanId and traceId
     * @param configService ConfigService to get hostName and entityName
     * @param rpmService    IRPMService to get entityGuid
     * @return Map of all agent linking metadata
     */
    public static Map getLinkingMetadata(TraceMetadata traceMetadata, ConfigService configService, IRPMService rpmService) {
        AgentConfig agentConfig = configService.getDefaultAgentConfig();
        Map linkingMetadata = new ConcurrentHashMap<>();

        linkingMetadata.put(TRACE_ID, getTraceId(traceMetadata));
        linkingMetadata.put(SPAN_ID, getSpanId(traceMetadata));
        linkingMetadata.put(HOSTNAME, getHostname(agentConfig));
        linkingMetadata.put(ENTITY_NAME, getEntityName(agentConfig));
        linkingMetadata.put(ENTITY_TYPE, getEntityType());

        try {
            String entityGuid = getEntityGuid(rpmService);
            if (!entityGuid.isEmpty()) {
                linkingMetadata.put(ENTITY_GUID, entityGuid);
            }
        } catch (NullPointerException ignored) {
            logWarning();
        }

        return linkingMetadata;
    }

    /**
     * Get a map of agent linking metadata minus
     * entity.type and any attributes with an empty value.
     * This subset of linking metadata is added to LogEvents.
     *
     * @param traceMetadata TraceMetadataImpl to get spanId and traceId
     * @param configService ConfigService to get hostName and entityName
     * @param rpmService    IRPMService to get entityGuid
     * @return Filtered map of agent linking metadata
     */
    public static Map getLogEventLinkingMetadata(TraceMetadata traceMetadata, ConfigService configService, IRPMService rpmService) {
        AgentConfig agentConfig = configService.getDefaultAgentConfig();
        Map logEventLinkingMetadata = new ConcurrentHashMap<>();

        String traceId = getTraceId(traceMetadata);
        if (!traceId.isEmpty()) {
            logEventLinkingMetadata.put(TRACE_ID, traceId);
        }

        String spanId = getSpanId(traceMetadata);
        if (!spanId.isEmpty()) {
            logEventLinkingMetadata.put(SPAN_ID, spanId);
        }

        String hostname = getHostname(agentConfig);
        if (!hostname.isEmpty()) {
            logEventLinkingMetadata.put(HOSTNAME, hostname);
        }

        String entityName = getEntityName(agentConfig);
        if (!entityName.isEmpty()) {
            logEventLinkingMetadata.put(ENTITY_NAME, entityName);
        }

        try {
            String entityGuid = rpmService.getEntityGuid();
            if (!entityGuid.isEmpty()) {
                logEventLinkingMetadata.put(ENTITY_GUID, entityGuid);
            }
        } catch (NullPointerException ignored) {
            logWarning();
        }

        return logEventLinkingMetadata;
    }

    public static String getTraceId(TraceMetadata traceMetadata) {
        return traceMetadata.getTraceId();
    }

    public static String getSpanId(TraceMetadata traceMetadata) {
        return traceMetadata.getSpanId();
    }

    private static String getHostname(AgentConfig agentConfig) {
        String fullHostname = Hostname.getFullHostname(agentConfig);
        if (fullHostname == null || fullHostname.isEmpty() || fullHostname.equals(LOCALHOST)) {
            return Hostname.getHostname(agentConfig);
        }
        return fullHostname;
    }

    public static String getEntityName(AgentConfig agentConfig) {
        return agentConfig.getApplicationName();
    }

    public static String getEntityType() {
        return ENTITY_TYPE_DEFAULT;
    }

    public static String getEntityGuid(IRPMService rpmService) {
        return rpmService.getEntityGuid();
    }

    private static void logWarning() {
        // It's possible to call getEntityGuid in the agent premain before the
        // RPMService has been initialized, which will cause a NullPointerException.
        Agent.LOG.log(Level.WARNING, "Cannot get entity.guid from getLinkingMetadata() until RPMService has initialized.");
    }
}