com.newrelic.agent.service.EventService 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 2020 New Relic Corporation. All rights reserved.
 *  * SPDX-License-Identifier: Apache-2.0
 *
 */

package com.newrelic.agent.service;

/**
 * Defines a service that sends New Relic events. These services can be
 * configured to harvest on a faster interval than other services.
 */
public interface EventService extends Service {

    /**
     * Perform the harvest of any pending events right now.
     *
     * @param appName the application to harvest for
     */
    void harvestEvents(final String appName);

    /**
     * Returns the metric name for this service that records the actual interval in which the harvest is happening. This is different
     * from the report period below because it will be the actual time between harvests, rather than the expected time.
     *
     * @return harvest interval metric name
     */
    String getEventHarvestIntervalMetric();

    /**
     * Returns the metric name for this service that records the expected report period. This will be the value we get back on connect.
     *
     * @return report period metric name
     */
    String getReportPeriodInSecondsMetric();

    /**
     * Returns the metric name for this service that records the harvest limit. This will be the value we get back on connect.
     *
     * @return event harvest limit metric name
     */
    String getEventHarvestLimitMetric();

    /**
     * Returns the current limit of events to store per harvest interval. For example, if the maximum size for a 60 second harvest is
     * is 10000 events and this service is configured for 5 second harvests this would return 833 (60/5 = 12, 10000/12 = 833).
     *
     * @return the maximum number of events to store per configured harvest interval
     */
    int getMaxSamplesStored();

    /**
     * Update the current limit of events to store per harvest interval.
     *
     * @param maxSamplesStored the new maximum number of events to store per harvest interval.
     */
    void setMaxSamplesStored(int maxSamplesStored);

    /**
     * Update the reporting period for harvesting, in case it is needed for config changes.
     *
     * @param reportPeriodInMillis the number of millis between reporting/harvesting cycles
     */
    default void setReportPeriodInMillis(long reportPeriodInMillis) {
        // do nothing
    }

    /**
     * Reset the event reservoir to allow for the next harvest to start
     */
    void clearReservoir();
}