Interactive electronic documentation for operational activities
Various embodiments support or provide for interactive electronic documentation (or an electronic document) for operational activities associated with a system or service, such as one monitored or maintained by a system administrator or engineer. In particular, some embodiments provide for an interactive electronic document associated with a runbook, which can comprise a set of actions (e.g., list of operations, procedures, steps, and the like) to be performed with respect to a system or service in connection with an operational event, such as a system/service incident, scheduled maintenance, or a support operation.
1. A method comprising:
receiving, by a hardware processor, a first user request from a client device to generate a definition for a runbook that comprises a set of actions with respect to a set of external systems or services, in response to the first user request to
causing, by the hardware processor, a graphical user interface, for defining the runbook, to be presented at the client device;
receiving, by the hardware processor, information entered by a first user through the graphical user interface, the received information defining the set of actions for the runbook, the received information defining a set of trigger conditions that when satisfied causes generation of an individual instance of the runbook, at least one condition in the set of trigger conditions being based on input data provided by at least one external system or service; and
generating, by the hardware processor, a stored definition of the runbook based on the received information;
monitoring, by the hardware processor, when the set of trigger conditions is satisfied for the runbook;
generating, by the hardware processor, a new instance of the runbook based on the stored definition in response to detecting that the set of trigger conditions is satisfied;
receiving by the hardware processor, a second user request from the client device to access data for the new instance of the runbook;
in response to the second user request sending to the client device an interactive electronic document for the new instance of the runbook, the interactive electronic document being generated based on the stored definition of the runbook, the interactive electronic document comprising
presentation of a timeline of activities performed or observed in association with the new instance of the runbook, the activities of the timeline including information regarding execution of any action, in the set of actions, in association with the new instance of the runbook;
receiving, by the hardware processor, a third user request from the client device to invoke at least one action, in the set of actions, with respect to an external system or service, the third user request being generated by a second user through the interactive electronic document; and
in response to the third user request:
causing, by the hardware processor, the at least one action to be executed with respect to the external system or service; and
updating, by the hardware processor, the activities of the timeline of the interactive electronic document to present information regarding the at least one action that indicates that the at least one action was invoked through the interactive electronic document.
2. The method of claim 1 , wherein in the set of actions, an individual action is configured to execute in response to satisfaction of an execution condition.
3. The method of claim 2 , wherein the execution condition for the individual action is satisfied when a user input for the individual action is received through a copy of an interactive electronic document generated for the new instance of the runbook.
4. The method of claim 2 , wherein the execution condition for the individual action is satisfied when the new instance of the runbook is generated.
5. The method of claim 1 , wherein in the set of actions, an individual action is configured to cause execution of a next action in the set of actions in response to the individual action completing execution.
6. The method of claim 1 , wherein the received information defines, in association with an individual action in the set of actions, a graphical element to be rendered as part of the interactive electronic document, the graphical element indicating a status of the individual action for the individual instance.
7. The method of claim 1 , wherein in the set of actions, an individual action is configured to prompt the second user for input information when the individual action is executed for the individual instance, the input information defining a parameter for performing the individual action.
8. The method of claim 1 , wherein the received information defines a prescribed order for executing the set of actions, the prescribed order determining a presentation order for presenting graphical elements associated with each action, in the set of actions, in the interactive electronic document.
9. The method of claim 1 , wherein the interactive electronic document comprises content that is updated with information relating to operational activity data provided by the at least one external system or service.
10. The method of claim 1 , comprising:
updating, by the hardware processor, stored data that describes the new instance of the runbook based on the causing of the at least one action to be executed with respect to the external system or service.
11. The method of claim 1 , wherein the interactive electronic document comprises a set of graphical elements associated with each action in the set of actions.
12. The method of claim 1 , comprising:
updating, by the hardware processor, stored data that describes the new instance of the runbook based on the input data, the updated stored data causing an update to a set of graphical elements rendered as part of the interactive electronic document.
13. The method of claim 1 , wherein the input data describes an operational event for the at least one external system or service.
14. The method of claim 13 , wherein the operational event comprises an alert generated by the at least one external system or service.
15. The method of claim 13 , comprising:
accessing, by the hardware processor, the input data from log data generated by the at least one external system or service.
16. A non-transitory computer-readable medium comprising instructions that, when executed by a hardware processor of a device, cause the device to perform operations comprising:
receiving a first user request from a client device to access data for an instance of a runbook, the instance of the runbook being generated based on a stored definition for the runbook, the instance of the runbook being generated for an operational event for a set of external systems or services;
monitoring input data from at least one external system or service;
in response to the first user request to access data for the instance of the runbook, sending to the client device an interactive electronic document for the instance of the runbook, the interactive electronic document being generated based on the stored definition of the runbook the interactive electronic document comprising presentation of a timeline of activities performed or observed in association with the instance of the runbook, the activities of the timeline including: information regarding execution of any action in association with the instance of the runbook;
generating update data for the interactive electronic document based on the monitoring of the input data, the update data being configured to cause at least the activities of the timeline of the interactive electronic document based on the input data;
sending the update data to the client device;
receiving a second user request from the client device to invoke at least one action with respect to the external system or service, the at least one action presented by the interactive electronic document, the second user request being generated by a user through the interactive electronic document at the client device; and
in response to the second user request:
causing the at least one action to be executed with respect to the external system or service; and
updating the activities of the timeline of the interactive electronic document to present information regarding the at least one action that indicates that the at least one action was invoked through the interactive electronic document.
17. A system comprising:
a memory storing instructions; and
one or more hardware processors communicatively coupled to the memory and configured by the instructions to perform operations comprising:
receiving a first user request from a client device to access data for an instance of a runbook, the instance of the runbook being generated based on a stored definition for the runbook, the instance of the runbook being generated for an operational event for a set of external systems or services;
in response to the first user request, sending to the client device an interactive electronic document for the instance of the runbook, the interactive electronic document being generated based on the stored definition of the runbook, the interactive electronic document comprising presentation of a timeline of activities performed or observed in association with the instance of the runbook, the activities of the timeline including information regarding execution of any action in association with the instance of the runbook:
receiving a second user request from the client device to invoke at least one action with respect to an external system or service, the at least one action presented by the interactive electronic document, the second user request being generated by a user through the interactive electronic document at the client device; and
in response to the second user request:
causing the at least one action to be executed with respect to the external system or service; and
updating the activities of the timeline of the interactive electronic document to present information regarding the at least one action that indicates that the at least one action was invoked through the interactive electronic document.
18. The method of claim 1 , wherein the information regarding the at least one action further indicates the at least one action was invoked through the interactive electronic document by the second user.
19. The non-transitory computer-readable medium of claim 16 , wherein the information regarding the at least one action further indicates the at least one action was invoked through the interactive electronic document by the user.
20. The system of claim 17 , wherein the information regarding the at least one action further indicates the at least one action was invoked through the interactive electronic document by the user.