com.tangosol.internal.metrics.MetricsFormatter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of coherence Show documentation

Oracle Coherence Community Edition

There is a newer version: 24.09

/*
 * Copyright (c) 2000, 2021, Oracle and/or its affiliates.
 *
 * Licensed under the Universal Permissive License v 1.0 as shown at
 * http://oss.oracle.com/licenses/upl.
 */
package com.tangosol.internal.metrics;


import java.io.IOException;
import java.io.Writer;


/**
 * An interface that should be implemented by concrete metrics formatters
 * we want to support (Prometheus, JSON, etc.)
 *
 * @author as  2019.06.29
 * @since 12.2.1.4.0
 */
public interface MetricsFormatter
    {
    /**
     * Write formatted metrics to the specified writer.
     *
     * @param writer  the {@link Writer} to write formatted metrics to
     *
     * @throws IOException if there is an error writing metrics
     */
    void writeMetrics(Writer writer) throws IOException;

    /**
     * Returns the media type this formatter produces.
     *
     * @return the media type this formatter produces
     */
    String getContentType();
    }