com.nike.riposte.server.config.AppInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of riposte-spi Show documentation

Riposte module riposte-spi

There is a newer version: 0.20.0

package com.nike.riposte.server.config;

/**
 * Interface for app & instance info required for metrics and healthcheck/service registry. See {@link
 * com.nike.riposte.server.config.impl.AppInfoImpl} for a basic DTO style implementation and static helper methods for
 * helping detect app ID and environment and factory methods for creating "local" instances.
 */
public interface AppInfo {

    /**
     * The value that should be returned by some methods of this interface if the correct value cannot be determined or
     * is otherwise unknown. This may or may not be a breaking error condition depending on your application's
     * requirements.
     */
    String UNKNOWN_VALUE = "unknown";

    /**
     * @return the AppId/name for this service (like activity). This should always be a valid value - never {@link
     * #UNKNOWN_VALUE}.
     */
    String appId();

    /**
     * @return the environment for the AppId (like test or prod). This should always be a valid value - never {@link
     * #UNKNOWN_VALUE}.
     */
    String environment();

    /**
     * @return the datacenter/region for the AppId (like us-west-2).
     */

    String dataCenter();

    /**
     * @return the instanceId/ip/hostname of this machine/VM running the AppId.
     */
    String instanceId();
}