Class: Couchbase::Options::Cluster::ApplicationTelemetry

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/options.rb,
/home/runner/work/couchbase-ruby-client/couchbase-ruby-client/lib/couchbase/options.rb

Overview

Application Telemetry Options for Cluster.connect. Part of Couchbase::Options::Cluster

See Also:

Stability:

  • Volatile: This API is subject to change at any time.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(enable: nil, override_endpoint: nil, backoff: nil, ping_interval: nil, ping_timeout: nil) {|_self| ... } ⇒ ApplicationTelemetry

Creates an instance of app telemetry options for Cluster.connect. Part of Couchbase::Options::Cluster.

Parameters:

  • enable (nil, Boolean) (defaults to: nil) —

    whether to enable application telemetry capture. Application telemetry is enabled by default.

  • override_endpoint (nil, String) (defaults to: nil) —

    overrides the default endpoint used for application service telemetry The endpoint must use the WebSocket protocol and the string should start with ws://.

  • backoff (nil, Integer, #in_milliseconds) (defaults to: nil) —

    specifies the duration to wait between connection attempts to an application telemetry endpoint

  • ping_interval (nil, Integer, #in_milliseconds) (defaults to: nil) —

    specifies how often the SDK should ping the application service telemetry collector

  • ping_timeout (nil, Integer, #in_milliseconds) (defaults to: nil) —

    specifies how long the SDK should wait for a ping response (pong) from the application service collector, before closing the connection and attempting to reconnect

Yields:

  • (_self)

Yield Parameters:

Stability:

  • Volatile: This API is subject to change at any time.



1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
 
# File 'lib/couchbase/options.rb', line 1932

def initialize(enable: nil,
               override_endpoint: nil,
               backoff: nil,
               ping_interval: nil,
               ping_timeout: nil)
  @enable = enable
  @override_endpoint = override_endpoint
  @backoff = backoff
  @ping_interval = ping_interval
  @ping_timeout = ping_timeout

  yield self if block_given?
end

Instance Attribute Details

#backoff ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds)

Stability:

  • Volatile: This API is subject to change at any time.



1915
1916
1917
 
# File 'lib/couchbase/options.rb', line 1915

def backoff
  @backoff
end

#enable ⇒ nil, Boolean

Returns:

  • (nil, Boolean)

Stability:

  • Volatile: This API is subject to change at any time.



1913
1914
1915
 
# File 'lib/couchbase/options.rb', line 1913

def enable
  @enable
end

#override_endpoint ⇒ nil, String

Returns:

  • (nil, String)

Stability:

  • Volatile: This API is subject to change at any time.



1914
1915
1916
 
# File 'lib/couchbase/options.rb', line 1914

def override_endpoint
  @override_endpoint
end

#ping_interval ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds)

Stability:

  • Volatile: This API is subject to change at any time.



1916
1917
1918
 
# File 'lib/couchbase/options.rb', line 1916

def ping_interval
  @ping_interval
end

#ping_timeout ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds)

Stability:

  • Volatile: This API is subject to change at any time.



1917
1918
1919
 
# File 'lib/couchbase/options.rb', line 1917

def ping_timeout
  @ping_timeout
end