atlas-api-client

Modules

atlas-api-client

atlas-api-client client library.

Functions

responseLog()

Request status log is used to to output the status of a request returned by the client.

atlas-api-client

atlas-api-client client library.

• atlas-api-client
  • AtlasAPIClient ⏏
    • new AtlasAPIClient(options)
    • instance
      • .getClusters(groupID, [options], [cb]) ⇒ Promise
      • .createCluster(params, [options], [cb]) ⇒ Promise
      • .deleteCluster(params, [options], [cb]) ⇒ Promise
      • .getCluster(params, [options], [cb]) ⇒ Promise
      • .updateCluster(params, [options], [cb]) ⇒ Promise
      • .getDatabaseUsers(groupID, [options], [cb]) ⇒ Promise
      • .createDatabaseUser(params, [options], [cb]) ⇒ Promise
      • .deleteDatabaseUser(params, [options], [cb]) ⇒ Promise
      • .getDatabaseUser(params, [options], [cb]) ⇒ Promise
      • .updateDatabaseUser(params, [options], [cb]) ⇒ Promise
      • .getProcesses(groupID, [options], [cb]) ⇒ Promise
      • .getProcessDatabases(params, [options], [cb]) ⇒ Promise
      • .getProcessDatabaseMeasurements(params, [options], [cb]) ⇒ Promise
      • .getProcessDisks(params, [options], [cb]) ⇒ Promise
      • .getProcessDiskMeasurements(params, [options], [cb]) ⇒ Promise
      • .getProcessMeasurements(params, [options], [cb]) ⇒ Promise
    • static
      • .RetryPolicies
        • .Exponential
        • .Single
        • .None
      • .Errors
        • .BadRequest ⇐ Error
        • .Unauthorized ⇐ Error
        • .NotFound ⇐ Error
        • .InternalError ⇐ Error
      • .DefaultCircuitOptions

AtlasAPIClient ⏏

atlas-api-client client

Kind: Exported class

new AtlasAPIClient(options)

Create a new client object.

Param	Type	Default	Description
options	Object		Options for constructing a client object.
[options.address]	string		URL where the server is located. Must provide this or the discovery argument
[options.discovery]	bool		Use clever-discovery to locate the server. Must provide this or the address argument
[options.timeout]	number		The timeout to use for all client requests, in milliseconds. This can be overridden on a per-request basis. Default is 5000ms.
[options.retryPolicy]	RetryPolicies	RetryPolicies.Single	The logic to determine which requests to retry, as well as how many times to retry.
[options.logger]	module:kayvee.Logger	logger.New("atlas-api-client-wagclient")	The Kayvee logger to use in the client.
[options.circuit]	Object		Options for constructing the client's circuit breaker.
[options.circuit.forceClosed]	bool		When set to true the circuit will always be closed. Default: true.
[options.circuit.maxConcurrentRequests]	number		the maximum number of concurrent requests the client can make at the same time. Default: 100.
[options.circuit.requestVolumeThreshold]	number		The minimum number of requests needed before a circuit can be tripped due to health. Default: 20.
[options.circuit.sleepWindow]	number		how long, in milliseconds, to wait after a circuit opens before testing for recovery. Default: 5000.
[options.circuit.errorPercentThreshold]	number		the threshold to place on the rolling error rate. Once the error rate exceeds this percentage, the circuit opens. Default: 90.

atlasAPIClient.getClusters(groupID, [options], [cb]) ⇒ Promise

Get All Clusters

Kind: instance method of AtlasAPIClient
Fulfill: Object
Reject: BadRequest
Reject: Unauthorized
Reject: NotFound
Reject: InternalError
Reject: Error

Param	Type	Description
groupID	string
[options]	object
[options.timeout]	number	A request specific timeout
[options.span]	Span	An OpenTracing span - For example from the parent request
[options.retryPolicy]	RetryPolicies	A request specific retryPolicy
[cb]	function

atlasAPIClient.createCluster(params, [options], [cb]) ⇒ Promise

Create a Cluster

Kind: instance method of AtlasAPIClient
Fulfill: Object
Reject: BadRequest
Reject: Unauthorized
Reject: NotFound
Reject: InternalError
Reject: Error

Param	Type	Description
params	Object
params.groupID	string
params.createOrUpdateClusterRequest
[options]	object
[options.timeout]	number	A request specific timeout
[options.span]	Span	An OpenTracing span - For example from the parent request
[options.retryPolicy]	RetryPolicies	A request specific retryPolicy
[cb]	function

atlasAPIClient.deleteCluster(params, [options], [cb]) ⇒ Promise

Deletes a cluster

Kind: instance method of AtlasAPIClient
Fulfill: undefined
Reject: BadRequest
Reject: Unauthorized
Reject: NotFound
Reject: InternalError
Reject: Error

Param	Type	Description
params	Object
params.groupID	string
params.clusterName	string
[options]	object
[options.timeout]	number	A request specific timeout
[options.span]	Span	An OpenTracing span - For example from the parent request
[options.retryPolicy]	RetryPolicies	A request specific retryPolicy
[cb]	function

atlasAPIClient.getCluster(params, [options], [cb]) ⇒ Promise

Gets a cluster

Kind: instance method of AtlasAPIClient
Fulfill: Object
Reject: BadRequest
Reject: NotFound
Reject: InternalError
Reject: Error

Param	Type	Description
params	Object
params.groupID	string
params.clusterName	string
[options]	object
[options.timeout]	number	A request specific timeout
[options.span]	Span	An OpenTracing span - For example from the parent request
[options.retryPolicy]	RetryPolicies	A request specific retryPolicy
[cb]	function

atlasAPIClient.updateCluster(params, [options], [cb]) ⇒ Promise

Update a Cluster

Kind: instance method of AtlasAPIClient
Fulfill: Object
Reject: BadRequest
Reject: Unauthorized
Reject: NotFound
Reject: InternalError
Reject: Error

Param	Type	Description
params	Object
params.groupID	string
params.clusterName	string
params.createOrUpdateClusterRequest
[options]	object
[options.timeout]	number	A request specific timeout
[options.span]	Span	An OpenTracing span - For example from the parent request
[options.retryPolicy]	RetryPolicies	A request specific retryPolicy
[cb]	function

atlasAPIClient.getDatabaseUsers(groupID, [options], [cb]) ⇒ Promise

Get All DatabaseUsers

Kind: instance method of AtlasAPIClient
Fulfill: Object
Reject: BadRequest
Reject: Unauthorized
Reject: NotFound
Reject: InternalError
Reject: Error

Param	Type	Description
groupID	string
[options]	object
[options.timeout]	number	A request specific timeout
[options.span]	Span	An OpenTracing span - For example from the parent request
[options.retryPolicy]	RetryPolicies	A request specific retryPolicy
[cb]	function

atlasAPIClient.createDatabaseUser(params, [options], [cb]) ⇒ Promise

Create a DatabaseUser

Kind: instance method of AtlasAPIClient
Fulfill: Object
Reject: BadRequest
Reject: Unauthorized
Reject: NotFound
Reject: InternalError
Reject: Error

Param	Type	Description
params	Object
params.groupID	string
params.createDatabaseUserRequest
[options]	object
[options.timeout]	number	A request specific timeout
[options.span]	Span	An OpenTracing span - For example from the parent request
[options.retryPolicy]	RetryPolicies	A request specific retryPolicy
[cb]	function

atlasAPIClient.deleteDatabaseUser(params, [options], [cb]) ⇒ Promise

Deletes a DatabaseUser

Kind: instance method of AtlasAPIClient
Fulfill: undefined
Reject: BadRequest
Reject: Unauthorized
Reject: NotFound
Reject: InternalError
Reject: Error

Param	Type	Description
params	Object
params.groupID	string
params.username	string
[options]	object
[options.timeout]	number	A request specific timeout
[options.span]	Span	An OpenTracing span - For example from the parent request
[options.retryPolicy]	RetryPolicies	A request specific retryPolicy
[cb]	function

atlasAPIClient.getDatabaseUser(params, [options], [cb]) ⇒ Promise

Gets a database user

Kind: instance method of AtlasAPIClient
Fulfill: Object
Reject: BadRequest
Reject: NotFound
Reject: InternalError
Reject: Error

Param	Type	Description
params	Object
params.groupID	string
params.username	string
[options]	object
[options.timeout]	number	A request specific timeout
[options.span]	Span	An OpenTracing span - For example from the parent request
[options.retryPolicy]	RetryPolicies	A request specific retryPolicy
[cb]	function

atlasAPIClient.updateDatabaseUser(params, [options], [cb]) ⇒ Promise

Update a DatabaseUser

Kind: instance method of AtlasAPIClient
Fulfill: Object
Reject: BadRequest
Reject: Unauthorized
Reject: NotFound
Reject: InternalError
Reject: Error

Param	Type	Description
params	Object
params.groupID	string
params.username	string
params.updateDatabaseUserRequest
[options]	object
[options.timeout]	number	A request specific timeout
[options.span]	Span	An OpenTracing span - For example from the parent request
[options.retryPolicy]	RetryPolicies	A request specific retryPolicy
[cb]	function

atlasAPIClient.getProcesses(groupID, [options], [cb]) ⇒ Promise

Get All Processes

Kind: instance method of AtlasAPIClient
Fulfill: Object
Reject: BadRequest
Reject: Unauthorized
Reject: NotFound
Reject: InternalError
Reject: Error

Param	Type	Description
groupID	string
[options]	object
[options.timeout]	number	A request specific timeout
[options.span]	Span	An OpenTracing span - For example from the parent request
[options.retryPolicy]	RetryPolicies	A request specific retryPolicy
[cb]	function

atlasAPIClient.getProcessDatabases(params, [options], [cb]) ⇒ Promise

Get the available databases for a Atlas MongoDB Process

Kind: instance method of AtlasAPIClient
Fulfill: Object
Reject: BadRequest
Reject: Unauthorized
Reject: NotFound
Reject: InternalError
Reject: Error

Param	Type	Description
params	Object
params.groupID	string
params.host	string
params.port	number
[params.pageNum]	number
[params.itemsPerPage]	number
[options]	object
[options.timeout]	number	A request specific timeout
[options.span]	Span	An OpenTracing span - For example from the parent request
[options.retryPolicy]	RetryPolicies	A request specific retryPolicy
[cb]	function

atlasAPIClient.getProcessDatabaseMeasurements(params, [options], [cb]) ⇒ Promise

Get the measurements of the specified database for a Atlas MongoDB process.

Kind: instance method of AtlasAPIClient
Fulfill: Object
Reject: BadRequest
Reject: Unauthorized
Reject: NotFound
Reject: InternalError
Reject: Error

Param	Type	Description
params	Object
params.groupID	string
params.host	string
params.port	number
params.databaseID	string
params.granularity	string
[params.period]	string
[params.start]	string
[params.end]	string
[params.m]	Array.<string>
[params.pageNum]	number
[params.itemsPerPage]	number
[options]	object
[options.timeout]	number	A request specific timeout
[options.span]	Span	An OpenTracing span - For example from the parent request
[options.retryPolicy]	RetryPolicies	A request specific retryPolicy
[cb]	function

atlasAPIClient.getProcessDisks(params, [options], [cb]) ⇒ Promise

Get the available disks for a Atlas MongoDB Process

Kind: instance method of AtlasAPIClient
Fulfill: Object
Reject: BadRequest
Reject: Unauthorized
Reject: NotFound
Reject: InternalError
Reject: Error

Param	Type	Description
params	Object
params.groupID	string
params.host	string
params.port	number
[params.pageNum]	number
[params.itemsPerPage]	number
[options]	object
[options.timeout]	number	A request specific timeout
[options.span]	Span	An OpenTracing span - For example from the parent request
[options.retryPolicy]	RetryPolicies	A request specific retryPolicy
[cb]	function

atlasAPIClient.getProcessDiskMeasurements(params, [options], [cb]) ⇒ Promise

Get the measurements of the specified disk for a Atlas MongoDB process.

Kind: instance method of AtlasAPIClient
Fulfill: Object
Reject: BadRequest
Reject: Unauthorized
Reject: NotFound
Reject: InternalError
Reject: Error

Param	Type	Description
params	Object
params.groupID	string
params.host	string
params.port	number
params.diskName	string
params.granularity	string
[params.period]	string
[params.start]	string
[params.end]	string
[params.m]	Array.<string>
[params.pageNum]	number
[params.itemsPerPage]	number
[options]	object
[options.timeout]	number	A request specific timeout
[options.span]	Span	An OpenTracing span - For example from the parent request
[options.retryPolicy]	RetryPolicies	A request specific retryPolicy
[cb]	function

atlasAPIClient.getProcessMeasurements(params, [options], [cb]) ⇒ Promise

Get measurements for a specific Atlas MongoDB process (mongod or mongos).

Kind: instance method of AtlasAPIClient
Fulfill: Object
Reject: BadRequest
Reject: Unauthorized
Reject: NotFound
Reject: InternalError
Reject: Error

Param	Type	Description
params	Object
params.groupID	string
params.host	string
params.port	number
params.granularity	string
[params.period]	string
[params.start]	string
[params.end]	string
[params.m]	Array.<string>
[params.pageNum]	number
[params.itemsPerPage]	number
[options]	object
[options.timeout]	number	A request specific timeout
[options.span]	Span	An OpenTracing span - For example from the parent request
[options.retryPolicy]	RetryPolicies	A request specific retryPolicy
[cb]	function

AtlasAPIClient.RetryPolicies

Retry policies available to use.

Kind: static property of AtlasAPIClient

• .RetryPolicies
  • .Exponential
  • .Single
  • .None

RetryPolicies.Exponential

The exponential retry policy will retry five times with an exponential backoff.

Kind: static constant of RetryPolicies

RetryPolicies.Single

Use this retry policy to retry a request once.

Kind: static constant of RetryPolicies

RetryPolicies.None

Use this retry policy to turn off retries.

Kind: static constant of RetryPolicies

AtlasAPIClient.Errors

Errors returned by methods.

Kind: static property of AtlasAPIClient

• .Errors
  • .BadRequest ⇐ Error
  • .Unauthorized ⇐ Error
  • .NotFound ⇐ Error
  • .InternalError ⇐ Error

Errors.BadRequest ⇐ Error

BadRequest

Kind: static class of Errors
Extends: Error
Properties

Name	Type
detail	string
error	number
message	string
reason	string

Errors.Unauthorized ⇐ Error

Unauthorized

Kind: static class of Errors
Extends: Error
Properties

Name	Type
detail	string
error	number
message	string
reason	string

Errors.NotFound ⇐ Error

NotFound

Kind: static class of Errors
Extends: Error
Properties

Name	Type
detail	string
error	number
message	string
reason	string

Errors.InternalError ⇐ Error

InternalError

Kind: static class of Errors
Extends: Error
Properties

Name	Type
detail	string
error	number
message	string
reason	string

AtlasAPIClient.DefaultCircuitOptions

Default circuit breaker options.

Kind: static constant of AtlasAPIClient

responseLog()

Request status log is used to to output the status of a request returned by the client.

Kind: global function