Add metrics instrumentation sqlalchemy (#1645)

instrumentation/opentelemetry-instrumentation-sqlalchemy/tests/test_sqlalchemy_metrics.py

@@ -0,0 +1,159 @@
+# Copyright The OpenTelemetry Authors
+#
+# 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.
+
+import sqlalchemy
+from sqlalchemy.pool import QueuePool
+
+from opentelemetry.instrumentation.sqlalchemy import SQLAlchemyInstrumentor
+from opentelemetry.test.test_base import TestBase
+
+
+class TestSqlalchemyMetricsInstrumentation(TestBase):
+    def setUp(self):
+        super().setUp()
+        SQLAlchemyInstrumentor().instrument(
+            tracer_provider=self.tracer_provider,
+        )
+
+    def tearDown(self):
+        super().tearDown()
+        SQLAlchemyInstrumentor().uninstrument()
+
+    def assert_pool_idle_used_expected(self, pool_name, idle, used):
+        metrics = self.get_sorted_metrics()
+        self.assertEqual(len(metrics), 1)
+        self.assert_metric_expected(
+            metrics[0],
+            [
+                self.create_number_data_point(
+                    value=idle,
+                    attributes={"pool.name": pool_name, "state": "idle"},
+                ),
+                self.create_number_data_point(
+                    value=used,
+                    attributes={"pool.name": pool_name, "state": "used"},
+                ),
+            ],
+        )
+
+    def test_metrics_one_connection(self):
+        pool_name = "pool_test_name"
+        engine = sqlalchemy.create_engine(
+            "sqlite:///:memory:",
+            pool_size=5,
+            poolclass=QueuePool,
+            pool_logging_name=pool_name,
+        )
+
+        metrics = self.get_sorted_metrics()
+        self.assertEqual(len(metrics), 0)
+
+        with engine.connect():
+            self.assert_pool_idle_used_expected(
+                pool_name=pool_name, idle=0, used=1
+            )
+
+        # After the connection is closed
+        self.assert_pool_idle_used_expected(
+            pool_name=pool_name, idle=1, used=0
+        )
+
+    def test_metrics_without_pool_name(self):
+        pool_name = ""
+        engine = sqlalchemy.create_engine(
+            "sqlite:///:memory:",
+            pool_size=5,
+            poolclass=QueuePool,
+        )
+
+        metrics = self.get_sorted_metrics()
+        self.assertEqual(len(metrics), 0)
+
+        with engine.connect():
+            self.assert_pool_idle_used_expected(
+                pool_name=pool_name, idle=0, used=1
+            )
+
+        # After the connection is closed
+        self.assert_pool_idle_used_expected(
+            pool_name=pool_name, idle=1, used=0
+        )
+
+    def test_metrics_two_connections(self):
+        pool_name = "pool_test_name"
+        engine = sqlalchemy.create_engine(
+            "sqlite:///:memory:",
+            pool_size=5,
+            poolclass=QueuePool,
+            pool_logging_name=pool_name,
+        )
+
+        metrics = self.get_sorted_metrics()
+        self.assertEqual(len(metrics), 0)
+
+        with engine.connect():
+            with engine.connect():
+                self.assert_pool_idle_used_expected(pool_name, idle=0, used=2)
+
+            # After the first connection is closed
+            self.assert_pool_idle_used_expected(pool_name, idle=1, used=1)
+
+        # After the two connections are closed
+        self.assert_pool_idle_used_expected(pool_name, idle=2, used=0)
+
+    def test_metrics_connections(self):
+        pool_name = "pool_test_name"
+        engine = sqlalchemy.create_engine(
+            "sqlite:///:memory:",
+            pool_size=5,
+            poolclass=QueuePool,
+            pool_logging_name=pool_name,
+        )
+
+        metrics = self.get_sorted_metrics()
+        self.assertEqual(len(metrics), 0)
+
+        with engine.connect():
+            with engine.connect():
+                self.assert_pool_idle_used_expected(
+                    pool_name=pool_name, idle=0, used=2
+                )
+
+            # After the first connection is closed
+            self.assert_pool_idle_used_expected(
+                pool_name=pool_name, idle=1, used=1
+            )
+
+            # Resume from idle to used
+            with engine.connect():
+                self.assert_pool_idle_used_expected(
+                    pool_name=pool_name, idle=0, used=2
+                )
+
+        # After the two connections are closed
+        self.assert_pool_idle_used_expected(
+            pool_name=pool_name, idle=2, used=0
+        )
+
+    def test_metric_uninstrument(self):
+        SQLAlchemyInstrumentor().uninstrument()
+        engine = sqlalchemy.create_engine(
+            "sqlite:///:memory:",
+            poolclass=QueuePool,
+        )
+
+        engine.connect()
+
+        metrics = self.get_sorted_metrics()
+        self.assertEqual(len(metrics), 0)