mongo 2.8.0 → 2.9.0.rc0

data/lib/mongo/monitoring/event/cmap.rb

@@ -0,0 +1,25 @@
+# Copyright (C) 2019 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'mongo/monitoring/event/cmap/base'
+require 'mongo/monitoring/event/cmap/connection_checked_in'
+require 'mongo/monitoring/event/cmap/connection_checked_out'
+require 'mongo/monitoring/event/cmap/connection_check_out_failed'
+require 'mongo/monitoring/event/cmap/connection_check_out_started'
+require 'mongo/monitoring/event/cmap/connection_closed'
+require 'mongo/monitoring/event/cmap/connection_created'
+require 'mongo/monitoring/event/cmap/connection_ready'
+require 'mongo/monitoring/event/cmap/pool_cleared'
+require 'mongo/monitoring/event/cmap/pool_closed'
+require 'mongo/monitoring/event/cmap/pool_created'

data/lib/mongo/monitoring/event/cmap/base.rb

@@ -0,0 +1,28 @@
+# Copyright (C) 2019 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  class Monitoring
+    module Event
+      module Cmap
+
+        # Base class for CMAP events.
+        #
+        # @since 2.9.0
+        class Base < Mongo::Event::Base
+        end
+      end
+    end
+  end
+end

data/lib/mongo/monitoring/event/cmap/connection_check_out_failed.rb

@@ -0,0 +1,78 @@
+# Copyright (C) 2019 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  class Monitoring
+    module Event
+      module Cmap
+
+        # Event published when a connection is unable to be checked out of a pool.
+        #
+        # @since 2.9.0
+        class ConnectionCheckOutFailed < Base
+
+          # @return [ Symbol ] POOL_CLOSED Indicates that the connection check
+          #   out failed due to the pool already being closed.
+          #
+          # @since 2.9.0
+          POOL_CLOSED = :pool_closed
+
+          # @return [ Symbol ] TIMEOUT Indicates that the connection check out
+          #   failed due to the timeout being reached before a connection
+          #   became available.
+          #
+          # @since 2.9.0
+          TIMEOUT = :timeout
+
+          # @return [ Mongo::Address ] address The address of the server the
+          #   connection would have connected to.
+          #
+          # @since 2.9.0
+          attr_reader :address
+
+          # @return [ Symbol ] reason The reason a connection was unable to be
+          #   acquired.
+          #
+          # @since 2.9.0
+          attr_reader :reason
+
+          # Create the event.
+          #
+          # @param [ Address ] address
+          # @param [ Symbol ] symbol
+          #
+          # @since 2.9.0
+          # @api private
+          def initialize(address, reason)
+            @reason = reason
+            @address = address
+          end
+
+          # Returns a concise yet useful summary of the event.
+          #
+          # @return [ String ] String summary of the event.
+          #
+          # @note This method is experimental and subject to change.
+          #
+          # @since 2.9.0
+          # @api experimental
+          def summary
+            "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} address=#{address} " +
+                "reason=#{reason}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/monitoring/event/cmap/connection_check_out_started.rb

@@ -0,0 +1,56 @@
+# Copyright (C) 2019 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  class Monitoring
+    module Event
+      module Cmap
+
+        # Event published when a thread begins attempting to check a connection out of a pool.
+        #
+        # @since 2.9.0
+        class ConnectionCheckOutStarted < Base
+
+          # @return [ Mongo::Address ] address The address of the server that the connection will
+          #   connect to.
+          #
+          # @since 2.9.0
+          attr_reader :address
+
+          # Create the event.
+          #
+          # @param [ Address ] address
+          #
+          # @since 2.9.0
+          # @api private
+          def initialize(address)
+            @address = address
+          end
+
+          # Returns a concise yet useful summary of the event.
+          #
+          # @return [ String ] String summary of the event.
+          #
+          # @note This method is experimental and subject to change.
+          #
+          # @since 2.9.0
+          # @api experimental
+          def summary
+            "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} address=#{address}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/monitoring/event/cmap/connection_checked_in.rb

@@ -0,0 +1,63 @@
+# Copyright (C) 2019 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  class Monitoring
+    module Event
+      module Cmap
+
+        # Event published when a connection is returned to a connection pool.
+        #
+        # @since 2.9.0
+        class ConnectionCheckedIn < Base
+
+          # @return [ Address ] address The address of the server the connection was connected to.
+          #
+          # @since 2.9.0
+          attr_reader :address
+
+          # @return [ Integer ] connection_id The ID of the connection.
+          #
+          # @since 2.9.0
+          attr_reader :connection_id
+
+          # Create the event.
+          #
+          # @example Create the event.
+          #   ConnectionCheckedIn.new(address, id)
+          #
+          # @since 2.9.0
+          # @api private
+          def initialize(address, id)
+            @address = address
+            @connection_id = id
+          end
+
+          # Returns a concise yet useful summary of the event.
+          #
+          # @return [ String ] String summary of the event.
+          #
+          # @note This method is experimental and subject to change.
+          #
+          # @since 2.9.0
+          # @api experimental
+          def summary
+            "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
+                "address=#{address} connection_id=#{connection_id}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/monitoring/event/cmap/connection_checked_out.rb

@@ -0,0 +1,64 @@
+# Copyright (C) 2019 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  class Monitoring
+    module Event
+      module Cmap
+
+        # Event published when a connection is successfully checked out out of a pool.
+        #
+        # @since 2.9.0
+        class ConnectionCheckedOut < Base
+
+          # @return [ Mongo::Address ] address The address of the server that the connection will
+          #   connect to.
+          #
+          # @since 2.9.0
+          attr_reader :address
+
+          # @return [ Integer ] connection_id The ID of the connection.
+          #
+          # @since 2.9.0
+          attr_reader :connection_id
+
+          # Create the event.
+          #
+          # @example Create the event.
+          #   ConnectionCheckedOut.new(address, id)
+          #
+          # @since 2.9.0
+          # @api private
+          def initialize(address, id)
+            @address = address
+            @connection_id = id
+          end
+
+          # Returns a concise yet useful summary of the event.
+          #
+          # @return [ String ] String summary of the event.
+          #
+          # @note This method is experimental and subject to change.
+          #
+          # @since 2.9.0
+          # @api experimental
+          def summary
+            "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
+                "address=#{address} connection_id=#{connection_id}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/monitoring/event/cmap/connection_closed.rb

@@ -0,0 +1,103 @@
+# Copyright (C) 2019 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  class Monitoring
+    module Event
+      module Cmap
+
+        # Event published when a connection is closed.
+        #
+        # @since 2.9.0
+        class ConnectionClosed < Base
+
+          # @return [ Symbol ] STALE Indicates that the connection was closed due to it being stale.
+          #
+          # @since 2.9.0
+          STALE = :stale
+
+          # @return [ Symbol ] IDLE Indicates that the connection was closed due to it being idle.
+          #
+          # @since 2.9.0
+          IDLE = :idle
+
+          # @return [ Symbol ] ERROR Indicates that the connection was closed due to it experiencing
+          #   an error.
+          #
+          # @since 2.9.0
+          ERROR = :error
+
+          # @return [ Symbol ] POOL_CLOSED Indicates that the connection was closed due to the pool
+          #   already being closed.
+          #
+          # @since 2.9.0
+          POOL_CLOSED = :pool_closed
+
+          # @return [ Symbol ] HANDSHAKE_FAILED Indicates that the connection was closed due to the
+          #   connection handshake failing.
+          #
+          # @since 2.9.0
+          HANDSHAKE_FAILED = :handshake_failed
+
+          # @return [ Symbol ] UNKNOWN Indicates that the connection was closed for an unknown reason.
+          #
+          # @since 2.9.0
+          UNKNOWN = :unknown
+
+          # @return [ Integer ] connection_id The ID of the connection.
+          #
+          # @since 2.9.0
+          attr_reader :connection_id
+
+          # @return [ Symbol ] reason The reason why the connection was closed.
+          #
+          # @since 2.9.0
+          attr_reader :reason
+
+          # @return [ Mongo::Address ] address The address of the server the pool's connections will
+          #   connect to.
+          #
+          # @since 2.9.0
+          attr_reader :address
+
+          # Create the event.
+          #
+          # @example Create the event.
+          #   ConnectionClosed.new(address, id, reason)
+          #
+          # @since 2.9.0
+          # @api private
+          def initialize(address, id, reason)
+            @reason = reason
+            @address = address
+            @connection_id = id
+          end
+
+          # Returns a concise yet useful summary of the event.
+          #
+          # @return [ String ] String summary of the event.
+          #
+          # @note This method is experimental and subject to change.
+          #
+          # @since 2.9.0
+          # @api experimental
+          def summary
+            "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
+                "address=#{address} connection_id=#{connection_id} reason=#{reason}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/monitoring/event/cmap/connection_created.rb

@@ -0,0 +1,64 @@
+# Copyright (C) 2019 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  class Monitoring
+    module Event
+      module Cmap
+
+        # Event published when a connection is created.
+        #
+        # @since 2.9.0
+        class ConnectionCreated < Base
+
+          # @return [ Mongo::Address ] address The address of the server the connection will connect
+          #   to.
+          #
+          # @since 2.9.0
+          attr_reader :address
+
+          # @return [ Integer ] connection_id The ID of the connection.
+          #
+          # @since 2.9.0
+          attr_reader :connection_id
+
+          # Create the event.
+          #
+          # @example Create the event.
+          #   ConnectionCreated.new(address, id)
+          #
+          # @since 2.9.0
+          # @api private
+          def initialize(address, id)
+            @address = address
+            @connection_id = id
+          end
+
+          # Returns a concise yet useful summary of the event.
+          #
+          # @return [ String ] String summary of the event.
+          #
+          # @note This method is experimental and subject to change.
+          #
+          # @since 2.9.0
+          # @api experimental
+          def summary
+            "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
+                "address=#{address} connection_id=#{connection_id}>"
+          end
+        end
+      end
+    end
+  end
+end