mx-bluesky 1.5.2__tar.gz → 1.5.3__tar.gz

{mx_bluesky-1.5.2 → mx_bluesky-1.5.3}/.vscode/mx-bluesky.code-workspace

@@ -13,6 +13,8 @@
             "editor.defaultFormatter": "ms-python.black-formatter"
         },
         "python.defaultInterpreterPath": ".venv/bin/python",
+        "python.analysis.extraPaths": ["../dodal"],
+        "python.analysis.autoImportCompletions": true,
         "terminal.integrated.gpuAcceleration": "off",
         "esbonio.sphinx.confDir": ""
     }

{mx_bluesky-1.5.2 → mx_bluesky-1.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mx-bluesky
-Version: 1.5.2
+Version: 1.5.3
 Summary: Bluesky tools for MX Beamlines at DLS
 Author-email: Dominic Oram <dominic.oram@diamond.ac.uk>
 License:                                  Apache License
@@ -235,12 +235,13 @@ Requires-Dist: scipy
 Requires-Dist: semver
 Requires-Dist: deepdiff
 Requires-Dist: matplotlib
+Requires-Dist: cachetools
+Requires-Dist: daq-config-server>=v1.0.0-rc.2
 Requires-Dist: blueapi>=0.15.0
-Requires-Dist: daq-config-server==0.1.1
 Requires-Dist: ophyd>=1.10.5
 Requires-Dist: ophyd-async>=0.10.0a2
 Requires-Dist: bluesky>=1.13.1
-Requires-Dist: dls-dodal==1.52.0
+Requires-Dist: dls-dodal>=1.55.0
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: build; extra == "dev"

{mx_bluesky-1.5.2 → mx_bluesky-1.5.3}/conftest.py

@@ -19,5 +19,5 @@ def pytest_addoption(parser):
 @pytest.fixture(scope="session", autouse=True)
 def default_session_fixture() -> Iterator[None]:
     print("Patching bluesky 0MQ Publisher in __main__ for the whole session")
-    with patch("mx_bluesky.hyperion.__main__.Publisher"):
+    with patch("mx_bluesky.hyperion.runner.Publisher"):
         yield

{mx_bluesky-1.5.2 → mx_bluesky-1.5.3}/docs/developer/hyperion/reference/coordinate-systems.rst

@@ -20,7 +20,7 @@ defined by ``rotation_direction`` which can be ``POSITIVE`` or ``NEGATIVE``
 
 The coordinate systems of the underlying hardware may differ from the request. At Diamond traditionally the omega 
 axis is implemented to be in the opposite direction, therefore the commands sent to the hardware are transformed and 
-the ``omega_flip`` feature flag controls this behaviour, which by default is set to ``True`` as this is 
+the ``omega_flip`` flag controls this behaviour, which by default is set to ``True`` as this is 
 generally expected to be required for the beamlines here.
 
 In the Nexus output file, there is provision for describing the choice of axis orientations in the nexus file, and 

{mx_bluesky-1.5.2 → mx_bluesky-1.5.3}/docs/index.rst

@@ -16,7 +16,14 @@ The documentation consists of a Developer Guide for MX-Bluesky, which also inclu
 
         The Developer Guide contains documentation on how to install, develop and contribute changes to MX-Bluesky; explanations about the purpose of the software and some of the technical concepts; as well as how-to guides and tutorials.
 
+    .. grid-item-card:: :material-regular:`code;4em`
+        :link: user/hyperion/index
+        :link-type: doc
+
+        The User Guide for the Hyperion UDC Service
+
 .. toctree::
     :hidden:
 
     developer/index
+    user/hyperion/index

mx_bluesky-1.5.3/docs/user/hyperion/alerts.rst

@@ -0,0 +1,68 @@
+Alerts
+------
+
+Hyperion can be configured to raise  in order to notify staff of issues with data collections or with Hyperion 
+itself.
+
+The currently supported alerting backend uses graylog alerting to send email alert notifications.
+
+Graylog Alert Configuration
+===========================
+
+When hyperion generates an alert it will generate the alert in the form of a log message that will be logged to graylog
+in the normal way.
+
+The log message will have the message ``***ALERT*** summary=<summary> content=<content>`` and will have the following 
+metadata as fields in the log message.
+
+.. csv-table:: Log message fields
+    :widths: auto
+    :header: "Field", "Description"
+
+    "alert_summary", "A single line summary of the alert, that could e.g. be used in an email summary"
+    "alert_content", "The plain text body of the alert message"
+    "beamline", "Beamline on which the alert was raised"
+    "container", "Container ID that was being processed"
+    "ispyb_url", "Link to the ISPyB page of the affected sample"
+    "graylog_url", "Link to the graylog stream in the minutes up to the event"
+    "proposal", "Proposal that was being processed"
+    "sample_id", "Sample ID that was being processed"
+    "visit", "Visit that was being processed"
+
+
+In order to configure alerts in Graylog you will need appropriate Graylog permissions to edit Event Definitions and 
+Notifications.
+
+Event Definitions define which log messages will trigger a Graylog Event, and the information that is contained in 
+the event.
+
+Notifications are triggered by a Graylog Event and define how the information in the event is dispatched to the 
+recipient(s).
+
+For the authoritative Graylog documentation, please see https://go2docs.graylog.org/current/interacting_with_your_log_data/alerts.html
+
+Notification Configuration
+--------------------------
+
+Go to the Alerts->Notifications tab in Graylog, you should see a searchable list of notifications, clicking on the 
+notification you want to edit and click the "Edit Notification" button.
+
+For an email notification, you can edit the subject, recipients, and the plain-text and HTML body.
+
+Inside the subject and body fields, you can include metadata from the event, for example ``${event.timestamp}`` will 
+expand to the event timestamp. 
+
+All the fields that are available in the event are available under the ``event.fields`` object, e.g. ``${event.fields.alert_summary}``
+
+Event Definitions
+-----------------
+
+In order to access fields from the log message, including the ones explicitly added by Hyperion and also any other 
+ones that graylog appends to the message, you must configure the Event Definition.
+
+To configure the Event Definition, go to the Alerts->Event Definitions tab and click on the notification definition, 
+then click "Edit Event Definition".
+
+Under Filter & Aggregation you can configure the conditions under which an event will be generated.
+Under Fields you can add custom fields to the event, for each additional field that you want to use in the 
+notification, you should click Add Custom Field, then populate the fields, see the existing definitions as a guide.

mx_bluesky-1.5.3/docs/user/hyperion/configuration.rst

@@ -0,0 +1,25 @@
+Configuration
+-------------
+
+Configuration of several properties that control Hyperion execution are available. These can be edited in the 
+``domain.properties`` file typically found in
+
+::
+
+    /dls_sw/<beamline>/software/daq_configuration/domain.properties
+
+
+.. csv-table:: Configuration properties
+    :widths: auto
+    :header: "Property Name", "Type", "Description"
+
+    "gda.gridscan.hyperion.flaskServerAddress", "host:port", "Configures the Hyperion server address that GDA connects to."
+    "gda.gridscan.hyperion.multipin", "boolean", "Controls whether multipin collection is enabled."
+    "gda.hyperion.use_grid_snapshots_for_rotation", "boolean", "If true, then rotation snapshots are generated from the grid snapshots instead of directly capturing them"
+    "gda.mx.hyperion.enabled",  "boolean",  "Controls whether GDA invokes Hyperion or performs collection itself"
+    "gda.mx.hyperion.panda.runnup_distance_mm", "double", "Controls the panda runup distance."
+    "gda.mx.hyperion.xrc.box_size", "double", "Configures the grid scan box size in microns."
+    "gda.mx.hyperion.use_panda_for_gridscans", "boolean", "If true then the Panda is used instead of the Zebra for XRC gridscans" 
+    "gda.mx.hyperion.xrc.use_gpu_results", "boolean", "If true, then zocalo gridscan processing uses the GPU results"
+    "gda.mx.hyperion.xrc.use_roi_mode", "boolean", "If true then ROI mode is used."
+    "gda.mx.udc.hyperion.enable", "boolean",  "Enables baton passing to Hyperion."

mx_bluesky-1.5.3/docs/user/hyperion/index.rst

@@ -0,0 +1,25 @@
+Hyperion User Guide
+===================
+
+The Hyperion User Guide describes how to run, configure and troubleshoot Hyperion. For installation instructions, see
+the Developer Guide.
+
+What is Hyperion?
+-----------------
+
+Hyperion is a service for running high throughput unattended data collection (UDC). It does not provide a user 
+interface, instead instructions are pulled from Agamemnon which is controlled by information obtained in ISPyB.
+
+Running Hyperion
+----------------
+
+When installed, Hyperion should be running automatically. If it is not running, it can be (re)started from GDA by 
+invoking ``hyperion_restart()`` from the Jython console.
+
+
+.. toctree::
+    :caption: Topics
+    :maxdepth: 1
+    :glob:
+
+    *

mx_bluesky-1.5.3/docs/user/hyperion/logging.rst

@@ -0,0 +1,41 @@
+Logging
+-------
+
+Hyperion logs to a number of different locations. The sections below describe the locations that are configured via 
+environment variables for a standard server install; for kubernetes deployments please check the deployment 
+``values.yaml`` for the configured locations. 
+
+Graylog
+~~~~~~~
+
+Graylog is the recommended way to view logs. It is used for more centralised logging which is also more easily 
+searched and archived. Log messages are sent to the `Hyperion graylog stream <https://graylog.diamond.ac.uk/streams/66264f5519ccca6d1c9e4e03/search>`_.
+
+
+Startup Log
+~~~~~~~~~~~
+
+When ``hyperion_restart()`` is called by GDA, it will log the initial console output to a log file. This log file 
+location is 
+controlled by the ``gda.logs.dir`` property and is typically ``/dls_sw/<beamline>/logs/bluesky``.
+
+On kubernetes deployments, the initial startup is sent to standard IO and is captured as part of the standard 
+kubernetes logging facility.
+
+Log files
+~~~~~~~~~
+
+By default, Hyperion logs to the filesystem.
+
+The log file location is controlled by the ``LOG_DIR`` environment value. Typically this can be found in 
+``/dls_sw/<beamline>/logs/bluesky``
+
+Debug Log
+~~~~~~~~~
+
+The standard logs files do not record all messages, only those at INFO level or higher, in order to keep storage 
+requirements to a minimum. 
+In the event of an error occurring, then trace-level logging for the most recent events (by default 5000) is flushed 
+to a separate set of log files. Due to the size of these files, they are stored separately from the main log files
+. These logs are located in ``/dls/tmp/<beamline>/logs/bluesky`` by default, or 
+otherwise as specified by the ``DEBUG_LOG_DIR`` environment variable.  

mx_bluesky-1.5.3/docs/user/hyperion/pvs.rst

@@ -0,0 +1,12 @@
+Special PVs
+-----------
+
+Baton
+~~~~~
+
+In order to arbitrate access to the beamline between Hyperion and GDA there are two baton string PVs REQUESTED_USER and 
+CURRENT_USER.
+
+Hyperion will only start operating once REQUESTED_USER has been set to Hyperion, at which point it will set 
+CURRENT_USER. To request the baton from Hyperion, set REQUESTED_USER to some other value, when Hyperion completes the
+current action, it will relinquish CURRENT_USER.

{mx_bluesky-1.5.2 → mx_bluesky-1.5.3}/helm/mx-bluesky-blueapi/values.yaml

@@ -11,9 +11,3 @@ zocalo:
     - name: rabbitmq-api-reader
       secretName: rmq-api-reader
       fileName: rabbitmq-api-reader.yml
-
-ispyb:
-  secrets:
-  - name: ispyb-creds
-    secretName: ispyb-creds
-    fileName: ispyb-credentials.yml

{mx_bluesky-1.5.2 → mx_bluesky-1.5.3}/pyproject.toml

@@ -38,16 +38,17 @@ dependencies = [
     "semver",
     "deepdiff",
     "matplotlib",
+    "cachetools",
     #
     # These dependencies may be issued as pre-release versions and should have a pin constraint
     # as by default pip-install will not upgrade to a pre-release.
     #
+    "daq-config-server>=v1.0.0-rc.2",
     "blueapi >= 0.15.0",
-    "daq-config-server == 0.1.1",
     "ophyd >= 1.10.5",
     "ophyd-async >= 0.10.0a2",
     "bluesky >= 1.13.1",
-    "dls-dodal == 1.52.0",
+    "dls-dodal >= 1.55.0",
 ]
 
 
@@ -94,8 +95,6 @@ run_extruder = "mx_bluesky.beamlines.i24.serial.run_serial:run_extruder"
 run_fixed_target = "mx_bluesky.beamlines.i24.serial.run_serial:run_fixed_target"
 hyperion = "mx_bluesky.hyperion.__main__:main"
 hyperion-callbacks = "mx_bluesky.hyperion.external_interaction.callbacks.__main__:main"
-hyperion-generate-test-nexus = "mx_bluesky.hyperion.utils.validation:generate_test_nexus"
-hyperion-populate-test-and-meta-files = "mx_bluesky.hyperion.utils.validation:copy_test_meta_data_files"
 redis_to_murko = "mx_bluesky.beamlines.i04.redis_to_murko_forwarder:main"
 
 [project.urls]
@@ -122,6 +121,7 @@ markers = [
     "skip_log_setup: marks tests so that loggers are not setup before the test.",
     "skip_in_pycharm: marks test as not working in pycharm testrunner",
     "system_test: marks tests as a system test",
+    "requires: marks a test as having an external dependency such as a service or hardware",
 ]
 addopts = """
     --tb=native -vv --doctest-modules --doctest-glob="*.rst" --durations=10
@@ -142,6 +142,8 @@ filterwarnings = [
     # Ignore warning about deprecations in python-workflows encountered during system tests
     # https://github.com/DiamondLightSource/python-workflows/issues/188
     "ignore:.*`Field` should not be instantiated.*:marshmallow.warnings.ChangedInMarshmallow4Warning",
+    #Remove when we drop python 3.11
+    "ignore:.*__contains__ will no longer raise TypeError.*:DeprecationWarning",
 ]
 # Doctest python code in docs, python code in src docstrings, test functions in tests
 testpaths = "docs src tests/unit_tests"

{mx_bluesky-1.5.2 → mx_bluesky-1.5.3}/src/mx_bluesky/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '1.5.2'
-__version_tuple__ = version_tuple = (1, 5, 2)
+__version__ = version = '1.5.3'
+__version_tuple__ = version_tuple = (1, 5, 3)
+
+__commit_id__ = commit_id = 'gd31a95a33'

mx_bluesky-1.5.3/src/mx_bluesky/beamlines/i04/__init__.py

@@ -0,0 +1,10 @@
+from mx_bluesky.beamlines.i04.experiment_plans.i04_grid_detect_then_xray_centre_plan import (
+    i04_grid_detect_then_xray_centre,
+)
+from mx_bluesky.beamlines.i04.thawing_plan import thaw, thaw_and_stream_to_redis
+
+__all__ = [
+    "thaw",
+    "thaw_and_stream_to_redis",
+    "i04_grid_detect_then_xray_centre",
+]

{mx_bluesky-1.5.2 → mx_bluesky-1.5.3}/src/mx_bluesky/beamlines/i04/experiment_plans/i04_grid_detect_then_xray_centre_plan.py

@@ -67,6 +67,7 @@ from mx_bluesky.common.preprocessors.preprocessors import (
     transmission_and_xbpm_feedback_for_collection_decorator,
 )
 from mx_bluesky.common.utils.context import device_composite_from_context
+from mx_bluesky.common.utils.log import LOGGER
 from mx_bluesky.phase1_zebra.device_setup_plans.setup_zebra import (
     setup_zebra_for_gridscan,
     tidy_up_zebra_after_gridscan,
@@ -184,9 +185,11 @@ def get_ready_for_oav_and_close_shutter(
 ):
     yield from bps.wait(PlanGroupCheckpointConstants.GRID_READY_FOR_DC)
     group = "get_ready_for_oav_and_close_shutter"
+    LOGGER.info("Non-udc tidy: Seting up beamline for OAV")
     yield from setup_beamline_for_OAV(
         smargon, backlight, aperture_scatterguard, group=group
     )
+    LOGGER.info("Non-udc tidy: Closing detector shutter")
     yield from bps.abs_set(
         detector_motion.shutter,
         0,

{mx_bluesky-1.5.2 → mx_bluesky-1.5.3}/src/mx_bluesky/beamlines/i24/serial/blueapi_config.yaml

@@ -7,11 +7,11 @@ env:
   events:
     broadcast_status_events: false
 api:
-  port: 25565
+  url: http://localhost:25565
   cors:
     allow_credentials: True
     origins: 
       - "*"
 stomp:
   enabled: true
-  host: i24-control.diamond.ac.uk
+  url: http://i24-control.diamond.ac.uk:61613

{mx_bluesky-1.5.2 → mx_bluesky-1.5.3}/src/mx_bluesky/common/experiment_plans/oav_grid_detection_plan.py

@@ -6,6 +6,7 @@ from typing import TYPE_CHECKING
 import bluesky.plan_stubs as bps
 import numpy as np
 from blueapi.core import BlueskyContext
+from bluesky.utils import MsgGenerator
 from dodal.devices.oav.oav_detector import OAV
 from dodal.devices.oav.pin_image_recognition import PinTipDetection
 from dodal.devices.oav.pin_image_recognition.utils import NONE_VALUE
@@ -49,6 +50,16 @@ def get_min_and_max_y_of_pin(
     return min_y, max_y
 
 
+def optimum_grid_detect_angles(smargon: Smargon) -> MsgGenerator[list[float]]:
+    """We need to match the 0 and -90 that the fast grid scan performs but the order in
+    which we do the grid detection does not matter so we do the closest angle first."""
+    current_omega = yield from bps.rd(smargon.omega)
+    if current_omega < -45:
+        return [-90, 0]
+    else:
+        return [0, -90]
+
+
 def grid_detection_plan(
     composite: OavGridDetectionComposite,
     parameters: OAVParameters,
@@ -90,8 +101,7 @@ def grid_detection_plan(
 
     grid_width_pixels = int(grid_width_microns / microns_per_pixel_x)
 
-    # The FGS uses -90 so we need to match it
-    for angle in [0, -90]:
+    for angle in (yield from optimum_grid_detect_angles(smargon)):
         yield from bps.mv(smargon.omega, angle)
         # need to wait for the OAV image to update
         # See #673 for improvements

mx_bluesky-1.5.3/src/mx_bluesky/common/external_interaction/alerting/__init__.py

@@ -0,0 +1,13 @@
+from mx_bluesky.common.external_interaction.alerting._service import (
+    AlertService,
+    Metadata,
+    get_alerting_service,
+    set_alerting_service,
+)
+
+__all__ = [
+    "AlertService",
+    "Metadata",
+    "get_alerting_service",
+    "set_alerting_service",
+]

mx_bluesky-1.5.3/src/mx_bluesky/common/external_interaction/alerting/_service.py

@@ -0,0 +1,82 @@
+from datetime import UTC, datetime, timedelta
+from enum import StrEnum
+from typing import Protocol
+from urllib.parse import quote, urlencode
+
+
+class Metadata(StrEnum):
+    """Metadata fields that can be specified by the caller when raising an alert."""
+
+    CONTAINER = "container"
+    SAMPLE_ID = "sample_id"
+    VISIT = "visit"
+
+
+class ExtraMetadata(StrEnum):
+    """Additional metadata fields that are automatically appended by
+    the AlertService implementations."""
+
+    ALERT_CONTENT = "alert_content"
+    ALERT_SUMMARY = "alert_summary"
+    BEAMLINE = "beamline"
+    GRAYLOG_URL = "graylog_url"
+    ISPYB_URL = "ispyb_url"
+    PROPOSAL = "proposal"
+
+
+class AlertService(Protocol):
+    """
+    Implemented by any backend that provides the ability to dispatch alerts to some
+    service that is capable of disseminating them via any of a variety of media such
+    as email, SMS, instant messaging, etc etc.
+    """
+
+    def raise_alert(self, summary: str, content: str, metadata: dict[Metadata, str]):
+        """
+        Raise an alert that will be forwarded to beamline support staff, which might
+        for example be used as the basis for an incident in an incident reporting system.
+        Args:
+            summary: One line summary of the alert, that might for instance be used
+                in an email subject line.
+            content: Plain text content detailing the nature of the incident.
+            metadata: A dict of strings that can be included as metadata in the alert for
+                those backends that support it. The summary and content will be included
+                by default.
+        """
+        pass
+
+
+_alert_service: AlertService
+
+
+def get_alerting_service() -> AlertService:
+    """Get the alert service for this instance."""
+    return _alert_service
+
+
+def set_alerting_service(service: AlertService):
+    """Set the alert service for this instance, call when the beamline is initialised."""
+    global _alert_service
+    _alert_service = service
+
+
+def ispyb_url(sample_id: str):
+    return f"https://ispyb.diamond.ac.uk/samples/sid/{quote(sample_id)}"
+
+
+def graylog_url(stream_id: str):
+    now = datetime.now(UTC)
+    from_utc = now - timedelta(minutes=5)
+    from_timestamp = from_utc.isoformat()
+    # Add 1 second for graylog timing jitter
+    to_utc = now + timedelta(seconds=1)
+    to_timestamp = to_utc.isoformat()
+    query_string = urlencode(
+        {
+            "streams": stream_id,
+            "rangetype": "absolute",
+            "from": from_timestamp,
+            "to": to_timestamp,
+        }
+    )
+    return "https://graylog.diamond.ac.uk/search?" + query_string

mx_bluesky-1.5.3/src/mx_bluesky/common/external_interaction/alerting/log_based_service.py

@@ -0,0 +1,57 @@
+import logging
+from typing import cast
+
+from dodal.log import LOGGER
+from dodal.utils import get_beamline_name
+
+from mx_bluesky.common.external_interaction.alerting import Metadata
+from mx_bluesky.common.external_interaction.alerting._service import (
+    ExtraMetadata,
+    graylog_url,
+    ispyb_url,
+)
+from mx_bluesky.common.external_interaction.callbacks.common.ispyb_mapping import (
+    get_proposal_and_session_from_visit_string,
+)
+
+
+class LoggingAlertService:
+    """
+    Implement an alert service that raises alerts by generating a specially formatted
+    log message, that may be intercepted by a logging service such as graylog and
+    used to dispatch the alert.
+    """
+
+    def __init__(self, graylog_stream_id: str, level=logging.WARNING):
+        """
+        Create a new instance of the service
+        Args:
+            level: The python logging level at which to generate the message
+        """
+        super().__init__()
+        self._level = level
+        self._graylog_stream_id = graylog_stream_id
+
+    def _append_extra_metadata(self, metadata: dict[Metadata, str]) -> dict[str, str]:
+        with_extras = cast(dict, metadata.copy())
+        with_extras[ExtraMetadata.GRAYLOG_URL] = graylog_url(self._graylog_stream_id)
+        with_extras[ExtraMetadata.BEAMLINE] = get_beamline_name("")
+        if sample_id := metadata.get(Metadata.SAMPLE_ID, None):
+            with_extras[ExtraMetadata.ISPYB_URL] = ispyb_url(sample_id)
+        if visit := metadata.get(Metadata.VISIT, None):
+            proposal, _ = get_proposal_and_session_from_visit_string(visit)
+            with_extras[ExtraMetadata.PROPOSAL] = proposal
+        return with_extras
+
+    def raise_alert(self, summary: str, content: str, metadata: dict[Metadata, str]):
+        message = f"***ALERT*** summary={summary} content={content}"
+        with_extras = self._append_extra_metadata(metadata)
+        LOGGER.log(
+            self._level,
+            message,
+            extra={
+                ExtraMetadata.ALERT_SUMMARY: summary,
+                ExtraMetadata.ALERT_CONTENT: content,
+            }
+            | with_extras,
+        )

{mx_bluesky-1.5.2 → mx_bluesky-1.5.3}/src/mx_bluesky/common/external_interaction/callbacks/sample_handling/sample_handling_callback.py

@@ -1,5 +1,10 @@
+from dodal.utils import get_beamline_name
 from event_model import RunStart, RunStop
 
+from mx_bluesky.common.external_interaction.alerting import (
+    Metadata,
+    get_alerting_service,
+)
 from mx_bluesky.common.external_interaction.callbacks.common.plan_reactive_callback import (
     PlanReactiveCallback,
 )
@@ -18,30 +23,36 @@ class SampleHandlingCallback(PlanReactiveCallback):
     def __init__(self, record_loaded_on_success=False):
         super().__init__(log=ISPYB_ZOCALO_CALLBACK_LOGGER)
         self._sample_id: int | None = None
+        self._visit: str | None = None
         self._descriptor: str | None = None
         self._run_id: str | None = None
+        self._container: int | None = None
 
         # Record 'sample loaded' if document successfully stops
         self.record_loaded_on_success = record_loaded_on_success
 
     def activity_gated_start(self, doc: RunStart):
         if not self._sample_id and self.active:
-            sample_id = doc.get("metadata", {}).get("sample_id")
+            metadata = doc.get("metadata", {})
+            sample_id = metadata.get("sample_id")
             self.log.info(f"Recording sample ID at run start {sample_id}")
             self._sample_id = sample_id
+            self._visit = metadata.get("visit")
             self._run_id = self.activity_uid
+            self._container = metadata.get("container")
 
     def activity_gated_stop(self, doc: RunStop) -> RunStop:
         if self._run_id == doc.get("run_start"):
             expeye = ExpeyeInteraction()
             if doc["exit_status"] != "success":
+                reason = doc.get("reason", "")
                 exception_type, message = SampleException.type_and_message_from_reason(
-                    doc.get("reason", "")
+                    reason
                 )
                 self.log.info(
                     f"Sample handling callback intercepted exception of type {exception_type}: {message}"
                 )
-                self._record_exception(exception_type, expeye)
+                self._record_exception(exception_type, expeye, reason)
 
             elif self.record_loaded_on_success:
                 self._record_loaded(expeye)
@@ -51,10 +62,23 @@ class SampleHandlingCallback(PlanReactiveCallback):
 
         return doc
 
-    def _record_exception(self, exception_type: str, expeye: ExpeyeInteraction):
+    def _record_exception(
+        self, exception_type: str, expeye: ExpeyeInteraction, reason: str
+    ):
         assert self._sample_id, "Unable to record exception due to no sample ID"
         sample_status = self._decode_sample_status(exception_type)
         expeye.update_sample_status(self._sample_id, sample_status)
+        if sample_status == BLSampleStatus.ERROR_BEAMLINE:
+            beamline = get_beamline_name("")
+            get_alerting_service().raise_alert(
+                f"UDC encountered an error on {beamline}",
+                f"Hyperion encountered the following beamline error: {reason}",
+                {
+                    Metadata.SAMPLE_ID: str(self._sample_id),
+                    Metadata.VISIT: self._visit or "",
+                    Metadata.CONTAINER: str(self._container),
+                },
+            )
 
     def _decode_sample_status(self, exception_type: str) -> BLSampleStatus:
         match exception_type: