agent Java API: exemple d'application instrumentée pour les datastore appels et le traçage distribué externe

Ce document montre l'utilisation de l'API de l'agent Java pour instrumenter des applications client et serveur simples. L'instrumentation a ces objectifs :

Pour enregistrer les datastore transactions HTTP externes et les transactions .
Pour lier des transactions externes entre deux applications exécutant l'agent New Relic (appelé tracing distribué ou DT).

Consultez la documentation Javadoc de l'API de l'agent Java pour obtenir une description complète des classes et méthodes API disponibles.

Important

Pour de meilleurs résultats lors de l'utilisation de l'API, assurez-vous que vous disposez de la dernière version agent Java . Plusieurs API utilisées dans les exemples nécessitent l’agent Java 3.36.0 ou supérieur.

Exemple côté client

Voici un exemple de code côté client pour une application client-serveur simple :

package com.newrelic.example;

import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.Statement;
import java.util.Arrays;
import java.util.Collection;
import java.util.stream.Collectors;

// New Relic API imports
import com.newrelic.api.agent.ExternalParameters;
import com.newrelic.api.agent.HeaderType;
import com.newrelic.api.agent.Headers;
import com.newrelic.api.agent.HttpParameters;
import com.newrelic.api.agent.NewRelic;
import com.newrelic.api.agent.Trace;
import com.newrelic.api.agent.TracedMethod;
import com.newrelic.api.agent.Transaction;

import fi.iki.elonen.NanoHTTPD;
import org.apache.http.HttpMessage;
import org.apache.http.NameValuePair;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.methods.RequestBuilder;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

public class NewRelicApiExample extends NanoHTTPD {

    public NewRelicApiExample() throws IOException, URISyntaxException {
        super(8080);

        // Set Dispatcher name and version
        NewRelic.setServerInfo("NanoHttp", "2.3.1");
        // Set Appserver port for JVM identification
        NewRelic.setAppServerPort(8080);
        // Set JVM instance name
        NewRelic.setInstanceName("Client");

        start(NanoHTTPD.SOCKET_READ_TIMEOUT, false);
        System.out.println("Running at: http://localhost:8080/");
    }

    public static void main(String[] args) throws URISyntaxException {
        try {
            new NewRelicApiExample();
        } catch (IOException ioe) {
            System.err.println("Unable to start the server:\n" + ioe);
        }
    }

    @Trace(dispatcher = true)
    @Override
    public Response serve(IHTTPSession session) {
        URI uri = null;
        int status = 0;

        try {
            createDB();
            Thread.sleep(1000);
            uri = new URI("http://localhost:8081");
            status = makeExternalCall(uri);
        } catch (URISyntaxException | InterruptedException | IOException e) {
            e.printStackTrace();
        }

        if (status == 200) {
            return newFixedLengthResponse("<html><body><h1>Successful Response</h1>\n</body></html>\n");
        } else {
            return newFixedLengthResponse("<html><body><h1>Error\n" + status + "</h1>\n</body></html>\n");
        }
    }

    @Trace
    public int makeExternalCall(URI uri) throws IOException {
        HttpUriRequest request = RequestBuilder.get().setUri(uri).build();

        // Wrap the outbound Request object
        Headers outboundHeaders = new HeadersWrapper(request);

        // Obtain a reference to the current transaction
        Transaction transaction = NewRelic.getAgent().getTransaction();
        // Add headers for outbound external request
        transaction.insertDistributedTraceHeaders(outboundHeaders);

        CloseableHttpClient connection = HttpClientBuilder.create().build();
        CloseableHttpResponse response = connection.execute(request);

        // Wrap the incoming Response object
        Headers inboundHeaders = new HeadersWrapper(response);

        // Create an input parameter object for a call to an external HTTP service
        ExternalParameters params = HttpParameters
            .library("HttpClient")
            .uri(uri)
            .procedure("execute")
            .inboundHeaders(inboundHeaders)
            .build();

        // Obtain a reference to the method currently being traced
        TracedMethod tracedMethod = NewRelic.getAgent().getTracedMethod();
        // Report a call to an external HTTP service
        tracedMethod.reportAsExternal(params);

        return response.getStatusLine().getStatusCode();
    }

    // Implement Headers interface to create a wrapper for the outgoing Request/incoming Response headers
    static class HeadersWrapper implements Headers {
        private final HttpMessage delegate;

        public HeadersWrapper(HttpMessage request) {
            this.delegate = request;
        }

        @Override
        public void setHeader(String name, String value) {
            delegate.setHeader(name, value);
        }

        @Override
        public HeaderType getHeaderType() {
            return HeaderType.HTTP;
        }

        @Override
        public String getHeader(String name) {
            return delegate.getFirstHeader(name).getValue();
        }

        @Override
        public Collection<String> getHeaders(String name) {
            return Arrays.stream(delegate.getHeaders(name))
                .map(NameValuePair::getValue)
                .collect(Collectors.toList());
        }

        @Override
        public void addHeader(String name, String value) {
            delegate.addHeader(name, value);
        }

        @Override
        public Collection<String> getHeaderNames() {
            return Arrays.stream(delegate.getAllHeaders())
                .map(NameValuePair::getName)
                .collect(Collectors.toSet());
        }

        @Override
        public boolean containsHeader(String name) {
            return Arrays.stream(delegate.getAllHeaders())
                .map(NameValuePair::getName)
                .anyMatch(headerName -> headerName.equals(name));
        }
    }

    @Trace
    public void createDB() {
        Connection c = null;
        Statement stmt = null;

        try {
            Class.forName("org.sqlite.JDBC");
            c = DriverManager.getConnection("jdbc:sqlite:/tmp/test.db");
            System.out.println("Opened database successfully");

            stmt = c.createStatement();

            String dropSql = "DROP TABLE IF EXISTS COMPANY;";
            stmt.executeUpdate(dropSql);

            String sql = "CREATE TABLE COMPANY " +
                    "(ID INT PRIMARY KEY     NOT NULL," +
                    " NAME           TEXT    NOT NULL, " +
                    " AGE            INT     NOT NULL, " +
                    " ADDRESS        CHAR(50), " +
                    " SALARY         REAL)";
            stmt.executeUpdate(sql);

            sql = "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY) " +
                   "VALUES (1, 'Paul', 32, 'California', 20000.00 );";
            stmt.executeUpdate(sql);

            sql = "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY) " +
                    "VALUES (2, 'Allen', 25, 'Texas', 15000.00 );";
            stmt.executeUpdate(sql);

            sql = "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY) " +
            "VALUES (3, 'Teddy', 23, 'Norway', 20000.00 );";
            stmt.executeUpdate(sql);

            sql = "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY) " +
                    "VALUES (4, 'Mark', 25, 'Rich-Mond ', 65000.00 );";
            stmt.executeUpdate(sql);

            stmt.close();
            c.close();
        } catch (Exception e) {
            System.err.println(e.getClass().getName() + ": " + e.getMessage());
            System.exit(0);
        }
    }
}

Voici le même code d'application client divisé en sections qui décrivent comment l'API est utilisée :

Cette section appelle les agent Java API importations utilisées pour ajouter le traçage distribué à application l'cliente plus tard dans l'exemple de code.

import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.Statement;
import java.util.Arrays;
import java.util.Collection;
import java.util.stream.Collectors;

// New Relic API imports
import com.newrelic.api.agent.ExternalParameters;
import com.newrelic.api.agent.HeaderType;
import com.newrelic.api.agent.Headers;
import com.newrelic.api.agent.HttpParameters;
import com.newrelic.api.agent.NewRelic;
import com.newrelic.api.agent.Trace;
import com.newrelic.api.agent.TracedMethod;
import com.newrelic.api.agent.Transaction;

import fi.iki.elonen.NanoHTTPD;
import org.apache.http.HttpMessage;
import org.apache.http.NameValuePair;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.methods.RequestBuilder;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

Cette section démarre le serveur client sur le port 8080 et utilise la classe NewRelic de l'API pour appeler les méthodes setServerInfo, setAppServerPort et setInstanceName. Ces appels d'API affectent ce qui est affiché dans l'UI de New Relic.

public NewRelicApiExample() throws IOException, URISyntaxException {
    super(8080);

    // Set Dispatcher name and version
    NewRelic.setServerInfo("NanoHttp", "2.3.1");
    // Set Appserver port for jvm identification
    NewRelic.setAppServerPort(8080);
    // Set JVM instance name
    NewRelic.setInstanceName("Client");

    start(NanoHTTPD.SOCKET_READ_TIMEOUT, false);
    System.out.println("Running at: http://localhost:8080/");
}

public static void main(String[] args) throws URISyntaxException {
    try {
        new NewRelicApiExample();
    } catch (IOException ioe) {
        System.err.println("Unable to start the server:\n" + ioe);
    }
}

Cette méthode crée un exemple de base de données, met le thread en veille et effectue un appel externe à l'application serveur à l'écoute sur le port 8081. L'annotation @Trace(dispatcher = true) indique à l'agent de démarrer une nouvelle transaction lorsque la méthode serve est appelée, si elle n'est pas appelée dans le cadre d'une transaction existante (et dans ce cas, ce n'est pas le cas). S'il était appelé dans le cadre d'une transaction existante, il serait simplement inclus dans cette transaction plutôt que d'en démarrer une nouvelle.

@Trace(dispatcher = true)
@Override
public Response serve(IHTTPSession session) {
    URI uri = null;
    int status = 0;

    try {
        createDB();
        Thread.sleep(1000);
        uri = new URI("http://localhost:8081");
        status = makeExternalCall(uri);
    } catch (URISyntaxException | InterruptedException | IOException e) {
        e.printStackTrace();
    }

    if (status == 200) {
        return newFixedLengthResponse("<html><body><h1>Successful Response</h1>\n</body></html>\n");
    } else {
        return newFixedLengthResponse("<html><body><h1>Error\n" + status + "</h1>\n</body></html>\n");
    }
}

Cette section contient le code qui initie le traçage distribué à l'application effectuant la demande. L'annotation @Trace indique à l'agent de suivre cette méthode dans le cadre d'une transaction existante démarrée par la méthode serve .

L'objet de requête est enveloppé par une classe qui implémente l'interface Headers de l'API de l'agent Java, ce qui garantit que le HeaderType approprié est défini (dans ce cas HTTP). Un appel à insertDistributedTraceHeaders ajoute les en-têtes à request et la requête est envoyée au serveur.

Lorsque le response est renvoyé, il est encapsulé par une classe implémentant l'interface InboundHeaders de l'API de l'agent Java. Headers est une sous-interface de InboundHeaders et, dans ce cas, la classe wrapper pourrait être réutilisée.

Les inboundHeaders, ainsi que les arguments "library", URI et "procedure", sont utilisés pour créer un objet HttpParameters . L'objet params est ensuite passé en argument à la méthode reportAsExternal, qui signale le TracedMethod comme un appel HTTP externe.

@Trace
public int makeExternalCall(URI uri) throws IOException {
    HttpUriRequest request = RequestBuilder.get().setUri(uri).build();

    // Wrap the outbound Request object
    Headers outboundHeaders = new HeadersWrapper(request);

    // Obtain a reference to the current transaction
    Transaction transaction = NewRelic.getAgent().getTransaction();
    // Add headers for outbound external request
    transaction.insertDistributedTraceHeaders(outboundHeaders);

    CloseableHttpClient connection = HttpClientBuilder.create().build();
    CloseableHttpResponse response = connection.execute(request);

    // Wrap the incoming Response object
    Headers inboundHeaders = new HeadersWrapper(response);

    // Create an input parameter object for a call to an external HTTP service
    ExternalParameters params = HttpParameters
        .library("HttpClient")
        .uri(uri)
        .procedure("execute")
        .inboundHeaders(inboundHeaders)
        .build();

    // Obtain a reference to the method currently being traced
    TracedMethod tracedMethod = NewRelic.getAgent().getTracedMethod();
    // Report a call to an external HTTP service
    tracedMethod.reportAsExternal(params);

    return response.getStatusLine().getStatusCode();
}

Une implémentation de l'interface Headers de l'API de l'agent Java est utilisée pour encapsuler l'objet de requête du serveur client, qui dans cet exemple est de type HttpUriRequest. La requête est transmise au constructeur de la classe HeadersWrapper et les implémentations des méthodes nécessaires sont fournies.

La méthode getHeaderType renvoie une énumération HeaderType qui peut être HeaderType.HTTP ou HeaderType.MESSAGE, comme défini par l'API de l'agent Java. Dans cet exemple, le protocole d'appel externe est HTTP, donc HeaderType.HTTP est renvoyé.

// Implement Headers interface to create a wrapper for the outgoing Request/incoming Response headers
static class HeadersWrapper implements Headers {
    private final HttpMessage delegate;

    public HeadersWrapper(HttpMessage request) {
        this.delegate = request;
    }

    @Override
    public void setHeader(String name, String value) {
        delegate.setHeader(name, value);
    }

    @Override
    public HeaderType getHeaderType() {
        return HeaderType.HTTP;
    }

    @Override
    public String getHeader(String name) {
        return delegate.getFirstHeader(name).getValue();
    }

    @Override
    public Collection<String> getHeaders(String name) {
        return Arrays.stream(delegate.getHeaders(name))
            .map(NameValuePair::getValue)
            .collect(Collectors.toList());
    }

    @Override
    public void addHeader(String name, String value) {
        delegate.addHeader(name, value);
    }

    @Override
    public Collection<String> getHeaderNames() {
        return Arrays.stream(delegate.getAllHeaders())
            .map(NameValuePair::getName)
            .collect(Collectors.toSet());
    }

    @Override
    public boolean containsHeader(String name) {
        return Arrays.stream(delegate.getAllHeaders())
            .map(NameValuePair::getName)
            .anyMatch(headerName -> headerName.equals(name));
    }
}

Cette méthode crée simplement un exemple de base de données SQLite. L'annotation @Trace indique à l'agent de suivre cette méthode dans le cadre d'une transaction existante démarrée par la méthode serve .

@Trace
public void createDB() {
    Connection c = null;
    Statement stmt = null;

    try {
        Class.forName("org.sqlite.JDBC");
        c = DriverManager.getConnection("jdbc:sqlite:/tmp/test.db");
        System.out.println("Opened database successfully");

        stmt = c.createStatement();

        String dropSql = "DROP TABLE IF EXISTS COMPANY;";
        stmt.executeUpdate(dropSql);

        String sql = "CREATE TABLE COMPANY " +
                "(ID INT PRIMARY KEY     NOT NULL," +
                " NAME           TEXT    NOT NULL, " +
                " AGE            INT     NOT NULL, " +
                " ADDRESS        CHAR(50), " +
                " SALARY         REAL)";
        stmt.executeUpdate(sql);

        sql = "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY) " +
               "VALUES (1, 'Paul', 32, 'California', 20000.00 );";
        stmt.executeUpdate(sql);

        sql = "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY) " +
                "VALUES (2, 'Allen', 25, 'Texas', 15000.00 );";
        stmt.executeUpdate(sql);

        sql = "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY) " +
        "VALUES (3, 'Teddy', 23, 'Norway', 20000.00 );";
        stmt.executeUpdate(sql);

        sql = "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY) " +
                "VALUES (4, 'Mark', 25, 'Rich-Mond ', 65000.00 );";
        stmt.executeUpdate(sql);

        stmt.close();
        c.close();
    } catch (Exception e) {
        System.err.println(e.getClass().getName() + ": " + e.getMessage());
        System.exit(0);
    }
}

Exemple côté serveur

Voici le code côté serveur pour cet exemple d'application :

package com.newrelic.example;

import java.io.IOException;
import java.net.URISyntaxException;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.Statement;
import java.util.Collection;
import java.util.Collections;

// New Relic API imports
import com.newrelic.api.agent.DatastoreParameters;
import com.newrelic.api.agent.HeaderType;
import com.newrelic.api.agent.Headers;
import com.newrelic.api.agent.NewRelic;
import com.newrelic.api.agent.Trace;
import com.newrelic.api.agent.TracedMethod;
import com.newrelic.api.agent.Transaction;
import com.newrelic.api.agent.TransportType;

import fi.iki.elonen.NanoHTTPD;

public class NewRelicApiServer extends NanoHTTPD {

    public NewRelicApiServer() throws IOException, URISyntaxException {
        super(8081);

        // Set Dispatcher name and version
        NewRelic.setServerInfo("NanoHttp", "2.3.1");
        // Set Appserver port for jvm identification
        NewRelic.setAppServerPort(8081);
        // Set JVM instance name
        NewRelic.setInstanceName("Server");

        start(NanoHTTPD.SOCKET_READ_TIMEOUT, false);
        System.out.println("\nRunning on http://localhost:8081/ \n");
    }

    public static void main(String[] args) throws URISyntaxException {
        try {
            new NewRelicApiServer();
        } catch (IOException ioe) {
            System.err.println("Unable to start the server:\n" + ioe);
        }
    }

    @Trace(dispatcher = true)
    @Override
    public Response serve(IHTTPSession session) {
        // Obtain a reference to the current Transaction
        Transaction tx = NewRelic.getAgent().getTransaction();
        // Set the name of the current transaction
        NewRelic.setTransactionName("Custom", "ExternalHTTPServer");

        // Wrap the Request object
        Headers req = new HeadersWrapper(session);

        // Set the request for the current transaction and convert it into a web transaction
        tx.acceptDistributedTraceHeaders(TransportType.HTTP, req);

        queryDB();

        return newFixedLengthResponse("<html><body><h1>SuccessfulResponse</h1>\n</body></html>\n");
    }

    // Implement Headers interface to create a wrapper for the outgoing Request/incoming Response headers
    static class HeadersWrapper implements Headers {
        private final IHTTPSession delegate;

        public HeadersWrapper(IHTTPSession request) {
            this.delegate = request;
        }

        @Override
        public HeaderType getHeaderType() {
            return HeaderType.HTTP;
        }

        @Override
        public String getHeader(String name) {
            return delegate.getHeaders().get(name);
        }

        @Override
        public Collection<String> getHeaders(String name) {
            return Collections.singletonList(getHeader(name));
        }

        @Override
        public void setHeader(String name, String value) {
            delegate.getHeaders().put(name, value);
        }

        @Override
        public void addHeader(String name, String value) {
            delegate.getHeaders().put(name, value);
        }

        @Override
        public Collection<String> getHeaderNames() {
            return delegate.getHeaders().keySet();
        }

        @Override
        public boolean containsHeader(String name) {
            return delegate.getHeaders().containsKey(name);
        }
    }

    @Trace
    public void queryDB() {
        Connection c = null;
        Statement stmt = null;
        try {
            Class.forName("org.sqlite.JDBC");
            c = DriverManager.getConnection("jdbc:sqlite:/tmp/test.db");
            c.setAutoCommit(false);
            System.out.println("Opened database successfully");

            stmt = c.createStatement();
            ResultSet rs = stmt.executeQuery("SELECT * FROM COMPANY;");
            while (rs.next()) {
                int id = rs.getInt("id");
                String name = rs.getString("name");
                int age = rs.getInt("age");
                String address = rs.getString("address");
                float salary = rs.getFloat("salary");
                System.out.println("ID = " + id);
                System.out.println("NAME = " + name);
                System.out.println("AGE = " + age);
                System.out.println("ADDRESS = " + address);
                System.out.println("SALARY = " + salary);
                System.out.println();
            }
            rs.close();
            stmt.close();
            c.close();
        } catch (Exception e) {
            System.err.println(e.getClass().getName() + ": " + e.getMessage());
            System.exit(0);
        }
        // Obtain a reference to the method currently being traced
        TracedMethod method = NewRelic.getAgent().getTracedMethod();

        // Create a DatastoreParameters object and report a call to an external datastore service
        method.reportAsExternal(
                DatastoreParameters
                        .product("sqlite")
                        .collection("test.db")
                        .operation("select")
                        .instance("localhost", 8080)
                        .databaseName("test.db")
                        .build());
    }
}

Voici le même exemple de code serveur divisé en sections qui décrivent comment l'API est utilisée :

Cette section présente les agent Java API importations pertinentes nécessaires pour ajouter le traçage distribué et la création de rapports sur les datastore appels externes à l'application serveur.

import java.io.IOException;
import java.net.URISyntaxException;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.Statement;
import java.util.Collection;
import java.util.Collections;

// New Relic API imports
import com.newrelic.api.agent.DatastoreParameters;
import com.newrelic.api.agent.HeaderType;
import com.newrelic.api.agent.Headers;
import com.newrelic.api.agent.NewRelic;
import com.newrelic.api.agent.Trace;
import com.newrelic.api.agent.TracedMethod;
import com.newrelic.api.agent.Transaction;
import com.newrelic.api.agent.TransportType;

import fi.iki.elonen.NanoHTTPD;

Cette section démarre le serveur sur le port 8081 et utilise la classe NewRelic de l'API pour appeler les méthodes setServerInfo, setAppServerPort et setInstanceName. Ces appels d'API affectent ce qui est affiché dans l'UI APM.

public NewRelicApiServer() throws IOException, URISyntaxException {
    super(8081);

    // Set Dispatcher name and version
    NewRelic.setServerInfo("NanoHttp", "2.3.1");
    // Set Appserver port for jvm identification
    NewRelic.setAppServerPort(8081);
    // Set JVM instance name
    NewRelic.setInstanceName("Server");

    start(NanoHTTPD.SOCKET_READ_TIMEOUT, false);
    System.out.println("\nRunning on http://localhost:8081/ \n");
}

public static void main(String[] args) throws URISyntaxException {
    try {
        new NewRelicApiServer();
    } catch (IOException ioe) {
        System.err.println("Unable to start the server:\n" + ioe);
    }
}

L'annotation @Trace(dispatcher = true) indique à l'agent de démarrer une nouvelle transaction lorsque la méthode serve est appelée si elle n'est pas appelée dans le cadre d'une transaction existante (ce qui n'est pas le cas dans ce cas). S'il était appelé dans le cadre d'une transaction existante, il serait simplement inclus dans cette transaction plutôt que d'en démarrer une nouvelle.

Une référence au Transaction actuel est obtenue via un appel à getTransaction et le nom de la transaction est défini via un appel à la méthode setTransactionName .

L'objet de requête, qui dans cet exemple est de type IHTTPSession, est ensuite encapsulé à l'aide d'une classe étendant la classe Headers de l'API de l'agent Java. Le Transaction actuel est ensuite lié à la trace parent via un appel à setWebRequest qui prend le ExtendedRequest encapsulé comme argument.

Un appel à la base de données est ensuite effectué et l’objet de réponse est renvoyé.

@Trace(dispatcher = true)
@Override
public Response serve(IHTTPSession session) {
    // Obtain a reference to the current Transaction
    Transaction tx = NewRelic.getAgent().getTransaction();
    // Set the name of the current transaction
    NewRelic.setTransactionName("Custom", "ExternalHTTPServer");

    // Wrap the Request object
    Headers req = new HeadersWrapper(session);

    // Set the request for the current transaction and convert it into a web transaction
    tx.acceptDistributedTraceHeaders(TransportType.HTTP, req);

    queryDB();

    return newFixedLengthResponse("<html><body><h1>SuccessfulResponse</h1>\n</body></html>\n");
}

Une autre implémentation de la classe Headers de l'API de l'agent Java est utilisée pour encapsuler l'objet de requête du serveur, qui dans cet exemple est de type IHTTPSession. La requête est transmise au constructeur de la classe HeadersWrapper, qui fournit des implémentations des méthodes getRequestURI, getHeader, getRemoteUser, getParameterNames, getParameterValues, getAttribute, getCookieValue, getHeaderType et getMethod .

// Implement Headers interface to create a wrapper for the outgoing Request/incoming Response headers
static class HeadersWrapper implements Headers {
    private final IHTTPSession delegate;

    public HeadersWrapper(IHTTPSession request) {
        this.delegate = request;
    }

    @Override
    public HeaderType getHeaderType() {
        return HeaderType.HTTP;
    }

    @Override
    public String getHeader(String name) {
        return delegate.getHeaders().get(name);
    }

    @Override
    public Collection<String> getHeaders(String name) {
        return Collections.singletonList(getHeader(name));
    }

    @Override
    public void setHeader(String name, String value) {
        delegate.getHeaders().put(name, value);
    }

    @Override
    public void addHeader(String name, String value) {
        delegate.getHeaders().put(name, value);
    }

    @Override
    public Collection<String> getHeaderNames() {
        return delegate.getHeaders().keySet();
    }

    @Override
    public boolean containsHeader(String name) {
        return delegate.getHeaders().containsKey(name);
    }
}

Cette méthode effectue un appel externe à la base de données SQLite créée par le client. L'annotation @Trace indique à l'agent de suivre cette méthode dans le cadre d'une transaction existante démarrée par la méthode serve .

Une référence au TracedMethod actuel est obtenue via un appel à getTracedMethod. Un objet DatastoreParameters est ensuite créé à l’aide du modèle de construction. L'objet ExternalParameters est ensuite passé en tant qu'argument à la méthode reportAsExternal, ce qui a pour effet de signaler le TracedMethod comme un appel datastore externe.

@Trace
public void queryDB() {
    Connection c = null;
    Statement stmt = null;
    try {
        Class.forName("org.sqlite.JDBC");
        c = DriverManager.getConnection("jdbc:sqlite:/tmp/test.db");
        c.setAutoCommit(false);
        System.out.println("Opened database successfully");

        stmt = c.createStatement();
        ResultSet rs = stmt.executeQuery("SELECT * FROM COMPANY;");
        while (rs.next()) {
            int id = rs.getInt("id");
            String name = rs.getString("name");
            int age = rs.getInt("age");
            String address = rs.getString("address");
            float salary = rs.getFloat("salary");
            System.out.println("ID = " + id);
            System.out.println("NAME = " + name);
            System.out.println("AGE = " + age);
            System.out.println("ADDRESS = " + address);
            System.out.println("SALARY = " + salary);
            System.out.println();
        }
        rs.close();
        stmt.close();
        c.close();
    } catch (Exception e) {
        System.err.println(e.getClass().getName() + ": " + e.getMessage());
        System.exit(0);
    }
    // Obtain a reference to the method currently being traced
    TracedMethod method = NewRelic.getAgent().getTracedMethod();

    // Create a DatastoreParameters object and report a call to an external datastore service
    method.reportAsExternal(
            DatastoreParameters
                    .product("sqlite")
                    .collection("test.db")
                    .operation("select")
                    .instance("localhost", 8080)
                    .databaseName("test.db")
                    .build());
}

Cette traduction automatique est fournie pour votre commodité.

agent Java API: exemple d'application instrumentée pour les datastore appels et le traçage distribué externe

Important

Exemple côté client

Exemple de code client complet

Importer des classes d'API d'agent Java

Démarrez le client et définissez les détails de l'environnement tels qu'ils sont affichés dans l'UI

Démarrer le traçage d'une transaction avec l'agent Java à l'aide de l'annotation @Trace

Effectuer un appel externe à l'aide de l'API de l'agent Java

Implémenter l'interface d'en-têtes de l'API de l'agent Java

Créer une base de données simple

Exemple côté serveur

Exemple de code de serveur complet

Importer des classes d'API d'agent Java

Démarrez le serveur et définissez ses informations telles qu'elles sont affichées dans UI

Commencez à tracer une transaction et ajoutez des en-têtes de réponse sortants

Étendre la classe Headers de l'API de l'agent Java

instrumenter un appel externe à une datastore

Cette traduction automatique est fournie pour votre commodité.

agent Java API: exemple d'application instrumentée pour les datastore appels et le traçage distribué externe

Important

Exemple côté client .css-21sua1{background:none;border:none;width:0;padding:0;}

Importer des classes d'API d'agent Java

Démarrez le client et définissez les détails de l'environnement tels qu'ils sont affichés dans l'UI

Démarrer le traçage d'une transaction avec l'agent Java à l'aide de l'annotation @Trace

Effectuer un appel externe à l'aide de l'API de l'agent Java

Implémenter l'interface d'en-têtes de l'API de l'agent Java

Créer une base de données simple

Exemple côté serveur

Exemple de code de serveur complet

Importer des classes d'API d'agent Java

Démarrez le serveur et définissez ses informations telles qu'elles sont affichées dans UI

Commencez à tracer une transaction et ajoutez des en-têtes de réponse sortants

Étendre la classe Headers de l'API de l'agent Java

instrumenter un appel externe à une datastore

Exemple côté client