org.glowroot.agent.collector.Collector Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of glowroot-agent-it-harness Show documentation
Glowroot Agent Integration Test Harness
There is a newer version: 0.14.0-beta.3
Show newest version
/*
 * Copyright 2015-2018 the original author or authors.
 *
 * Licensed 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.glowroot.agent.collector;

import java.io.File;
import java.io.IOException;
import java.sql.SQLException;
import java.util.List;

import org.glowroot.agent.shaded.org.glowroot.wire.api.model.AgentConfigOuterClass.AgentConfig;
import org.glowroot.agent.shaded.org.glowroot.wire.api.model.AggregateOuterClass.Aggregate;
import org.glowroot.agent.shaded.org.glowroot.wire.api.model.CollectorServiceOuterClass.GaugeValueMessage.GaugeValue;
import org.glowroot.agent.shaded.org.glowroot.wire.api.model.CollectorServiceOuterClass.InitMessage.Environment;
import org.glowroot.agent.shaded.org.glowroot.wire.api.model.CollectorServiceOuterClass.LogMessage.LogEvent;
import org.glowroot.agent.shaded.org.glowroot.wire.api.model.ProfileOuterClass.Profile;
import org.glowroot.agent.shaded.org.glowroot.wire.api.model.TraceOuterClass.Trace;

public interface Collector {

    void init(List confDir, Environment environment, AgentConfig agentConfig,
            AgentConfigUpdater agentConfigUpdater) throws Exception;

    void collectAggregates(AggregateReader aggregateReader) throws Exception;

    void collectGaugeValues(List gaugeValues) throws Exception;

    void collectTrace(TraceReader traceReader) throws Exception;

    void log(LogEvent logEvent) throws Exception;

    interface AgentConfigUpdater {
        void update(AgentConfig agentConfig) throws IOException;
    }

    public interface AggregateReader {
        long captureTime();
        void accept(AggregateVisitor aggregateVisitor) throws Exception;
    }

    public interface TraceReader {
        long captureTime();
        String traceId();
        boolean partial();
        boolean update();
        void accept(TraceVisitor traceVisitor) throws Exception;
        // alternate to accept() if only header data may be needed, can still call accept afterwards
        Trace.Header readHeader();
    }

    public interface AggregateVisitor {
        void visitOverallAggregate(String transactionType, List sharedQueryTexts,
                Aggregate overallAggregate) throws Exception;
        void visitTransactionAggregate(String transactionType, String transactionName,
                List sharedQueryTexts, Aggregate transactionAggregate) throws Exception;
    }

    public interface TraceVisitor {
        void visitEntry(Trace.Entry entry);
        void visitQueries(List queries);
        void visitSharedQueryTexts(List sharedQueryTexts) throws SQLException;
        void visitMainThreadProfile(Profile profile);
        void visitAuxThreadProfile(Profile profile);
        void visitHeader(Trace.Header header);
    }
}