123456789_123456789_123456789_123456789_123456789_

Class: Mongo::Server::Monitor::AppMetadata Private

Do not use. This class is for internal use only.
Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::Mongo::Server::AppMetadata, Forwardable
Instance Chain:
self, ::Mongo::Server::AppMetadata
Inherits: Mongo::Server::AppMetadata
Defined in: lib/mongo/server/monitor/app_metadata.rb

Overview

App metadata for monitoring sockets.

It is easiest to start with the normal app metadata and remove authentication-related bits.

Since:

  • 2.0.0

Constant Summary

::Mongo::Server::AppMetadata - Inherited

AUTH_OPTION_KEYS, DRIVER_NAME, MAX_APP_NAME_SIZE, PURPOSES

Class Method Summary

::Mongo::Server::AppMetadata - Inherited

.new

Instantiate the new AppMetadata object.

Instance Attribute Summary

::Mongo::Server::AppMetadata - Inherited

#platform, #purpose, #server_api, #wrapping_libraries

Instance Method Summary

::Mongo::Server::AppMetadata - Inherited

#client_document

Get BSON::Document to be used as value for client key in handshake document.
#validated_document

Get the metadata as BSON::Document to be sent to as part of the handshake.
#architecture,
#check_purpose!

Verifies that the given purpose is either nil, or is one of the allowed purposes.
#document

Get the metadata as BSON::Document to be sent to as part of the handshake.
#driver_doc,
#env_doc

Returns the environment doc describing the current execution environment.
#name, #os_doc, #platform_string, #type,
#validate!

Check whether it is possible to build a valid app metadata document with params provided on intialization.