Set logger name, and include in examples and docstrings.

examples/0_Getting_started.py

@@ -131,10 +131,23 @@
 
 # ## Logging
 
-# All query results also contain a list of messages that were returned by the server when running the query. These are
-# sorted in order of decreasing severity. The same messages are logged in the Service Layer log file. These messages are
-# also visible as logs if the standard Python `logging` module is used.
+# All query results contain a list of messages that were returned by the server when running the query. These are
+# sorted in order of decreasing severity. The same messages are also available in the Service Layer log file.
 
 # + tags=[]
 result.messages
 # -
+
+# These messages are also available via the standard `logging` module using the 'ansys.grantami.bomanalytics' logger.
+# Alternatively, omit the logger name to get the root logger, which will include messages logged by all packages.
+# The code below creates a log handler that outputs all bomanalytics messages with severity INFO and above to either the
+# terminal or the notebook.
+
+# + tags=[]
+import logging
+
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger("ansys.grantami.bomanalytics")
+
+result = cxn.run(query)
+# -

src/ansys/grantami/bomanalytics/_connection.py

@@ -47,7 +47,7 @@
         BomComplianceQueryResult,
     )
 
-logger = logging.getLogger(__name__)
+logger = logging.getLogger("ansys.grantami.bomanalytics")
 
 
 class Connection(common.ApiClientFactory):

src/ansys/grantami/bomanalytics/_query_results.py

@@ -121,9 +121,10 @@ def messages(self) -> List[LogMessage]:
         """[TECHDOCS] Messages generated by Granta MI when running the query. The presence of one or more messages means
         something unexpected happened when running the query, but the query could still be completed.
 
-        Messages are sorted in order of decreasing severity. Messages are also logged in the Service Layer log on the
-        Granta MI server, and are logged using the Python `logging` module. By default, messages with a severity of
-        "warning" or higher are printed on stderr.
+        Messages are sorted in order of decreasing severity. Messages are also available in the Service Layer log file.
+
+        Messages are also logged using the Python `logging` module to the "ansys.grantami.bomanalytics" logger. By
+        default, messages with a severity of "warning" or higher are printed on stderr.
 
         Returns
         -------

src/ansys/grantami/bomanalytics/queries.py

@@ -48,7 +48,7 @@
 Query_Builder = TypeVar("Query_Builder", covariant=True, bound=Union["_BaseQueryBuilder", "_ApiMixin"])
 Query_Result = TypeVar("Query_Result", covariant=True, bound=Union[ComplianceBaseClass, ImpactedSubstancesBaseClass])
 
-logger = logging.getLogger(__name__)
+logger = logging.getLogger("ansys.grantami.bomanalytics")
 EXCEPTION_MAP = {
     "critical": logger.critical,
     "error": logger.error,