Interface PrivateApi

  • All Known Implementing Classes:
    NoOpPrivateApi

    public interface PrivateApi
    • Method Detail

      • addSampler

        java.io.Closeable addSampler​(java.lang.Runnable sampler,
                                     int period,
                                     java.util.concurrent.TimeUnit timeUnit)
        Adds a sampler to be called at a given frequency.
        Parameters:
        sampler -
        period -
        timeUnit -
        Returns:
        a Closeable which when executed will cancel the sampler execution.
      • setServerInfo

        void setServerInfo​(java.lang.String serverInfo)
      • addCustomAttribute

        void addCustomAttribute​(java.lang.String key,
                                java.lang.Number value)
        Add a key/value pair to the current transaction. These are reported in errors and transaction traces. This will add the parameter even if high_security is set. Use with caution.
        Parameters:
        key - Custom parameter key.
        value - Custom parameter value. @
      • addCustomAttribute

        void addCustomAttribute​(java.lang.String key,
                                java.util.Map<java.lang.String,​java.lang.String> values)
        Add a key with a map of values to the current transaction. These are reported in errors and transaction traces. This will add the parameter even if high_security is set. Use with caution.
        Parameters:
        key - Custom parameter key.
        values - Custom parameter values. @
      • addCustomAttribute

        void addCustomAttribute​(java.lang.String key,
                                java.lang.String value)
        Add a key/value pair to the current transaction. These are reported in errors and transaction traces. This will add the parameter even if high_security is set. Use with caution.
        Parameters:
        key - Custom parameter key.
        value - Custom parameter value. @
      • addTracerParameter

        void addTracerParameter​(java.lang.String key,
                                java.lang.Number value)
      • addTracerParameter

        void addTracerParameter​(java.lang.String key,
                                java.lang.String value)
      • addTracerParameter

        void addTracerParameter​(java.lang.String key,
                                java.lang.String value,
                                boolean addToSpan)
      • addTracerParameter

        void addTracerParameter​(java.lang.String key,
                                java.util.Map<java.lang.String,​java.lang.String> values)
      • addMBeanServer

        void addMBeanServer​(javax.management.MBeanServer server)
        Call if you want to pull JMX metrics from this server instead of the default MBeanServers.
        Parameters:
        server - The server to use for pulling MBeans.
      • removeMBeanServer

        void removeMBeanServer​(javax.management.MBeanServer serverToRemove)
        Call if you want to remove a particular MBeanServer.
        Parameters:
        serverToRemove - The desired server to remove from the JMXService.
      • reportHTTPError

        void reportHTTPError​(java.lang.String message,
                             int statusCode,
                             java.lang.String uri)
        Report an HTTP error
        Parameters:
        message - Error message
        statusCode - HTTP status code
        uri - Request URI
      • reportException

        void reportException​(java.lang.Throwable throwable)
        Report an exception. Checks if throwable should be ignored before reporting it.
        Parameters:
        throwable -
      • setAppServerPort

        @Deprecated
        void setAppServerPort​(int port)
        Set the app server port which is reported to RPM.
        Parameters:
        port -
      • setServerInfo

        @Deprecated
        void setServerInfo​(java.lang.String dispatcherName,
                           java.lang.String version)
        Set the dispatcher name and version which is reported to RPM.
        Parameters:
        version -
      • setInstanceName

        @Deprecated
        void setInstanceName​(java.lang.String instanceName)
        Set the instance name in the environment. A single host:port may support multiple JVM instances. The instance name is intended to help the customer identify the specific JVM instance.
        Parameters:
        instanceName -