Interface NewRelicClient

  • All Known Implementing Classes:
    NewRelicClientImpl

    public interface NewRelicClient
    REST client interface for the New Relic API.
    • Method Detail

      • sendNotification

        void sendNotification​(String apiKey,
                              String applicationId,
                              String description,
                              String revision,
                              String changelog,
                              String user)
                       throws IOException
        Submit deployment notification
        Parameters:
        apiKey - New Relic API key
        applicationId - Application to register deployment for
        description - Text annotation for the deployment
        revision - The revision number from your source control system
        changelog - A list of changes for this deployment
        user - The name of the user/process that triggered this deployment
        Throws:
        IOException - when HttpClient is not able to be closed or unexpected status code received
        See Also:
        https://docs.newrelic.com/docs/apm/apis/requirements/api-key
      • getApiEndpoint

        String getApiEndpoint()
        Get API Endpoint URL for looking up credentials.
        Returns:
        The endpoint URL for the New Relic API