HAI Use Case: Turn on/off OLFS debugging and view/save/stream the output

From OPeNDAP Documentation

Point Of Contact: Nathan Potter

1 Description

Allows the Administrator to control the OLFS logging framework.

2 Goal

Improving Admin problem solving by allowing the Admin to easily change debugging controls for the OLFs and to capture to a file or stream the debugging output of the OLFS.

3 Summary

The Admin logs into the HAI and uses the HAI interface to control and direct the output of the OLFS logging framework.

4 Actors

  • Administrator
  • HAI
  • Hyrax (OLFS & BES(s))

5 Preconditions

The Administrator has an authentication privileges for an HAI.

6 Triggers

The Admin wants to view and control the OLFS logging output.

7 Basic Flow

  1. The Admin logs into the HAI
  2. The Admin uses the HAI interface and chooses to control the OLFS logging activity.
  3. In the returned page (or portion thereof) the HAI provides an interface through which the Admin can:
    1. Control the logging levels of the OLFS logging framework.
    2. Control the level of logging output for different package/class components of the OLFS
    3. Save the loging output to a local file.
    4. Stream the logging output to the HAI interface.
    5. View existing log files for the OLFS.

8 Alternate Flow

Here we give any alternate flows that might occur. May include flows that involve error conditions. Or flows that fall outside of the basic flow.

9 Post Conditions

Here we give any conditions that will be true of the state of the system after the use case has been completed.

10 Activity Diagram

Here a diagram is given to show the flow of events that surrounds the use case.

11 Notes

There is always some piece of information that is required that has no other place to go. This is the place for that information.

12 Resources

In order to support the capabilities described in this Use Case, a set of resources must be available and/or configured. These resources include data and services, and the systems that offer them. This section will call out examples of these resources.

Resource Owner Description Availability Source System
name Organization that owns/ manages resource Short description of the resource How often the resource is available Name of system which provides resource