Skip to content

Documentation: dry run and the state of being active are not mutually exclusive #59

@thomas-nicolai-frequenz

Description

@thomas-nicolai-frequenz

What's needed?

Improved documentation for using is_active and is_dry_run properties. The properties is_dry_run and the state of being active are not mutually exclusive. For example, there might be the case where a dispatch is being executed repeatedly as a dry run, because a developer does not want any changes to be written anywhere, but still wants to see the logs. The developer could then want to deactivate this dry run dispatch for some time.

Proposed solution

Enhance the documentation of the is_active and is_dry_run properties in the Dispatch message.

message Dispatch {
  // ... 

  // The "active" status
  // An active dispatch is eligible for processing, either immediately or at a scheduled time in the future, 
  // including recurring dispatches. If a dispatch is set to inactive, it won't be processed even
  // if it matches all other conditions, allowing for temporary disabling of
  // dispatches without deletion.
  bool is_active = 9;

  // The "dry run" status
  // A dry run dispatch is executed for logging and monitoring purposes 
  // without affecting the microgrid components. This is useful, for example,
  // in scenarios where a user may want to test dispatch behavior without
  // actually affecting any component states.
  // Notably, a dispatch can be both "dry run" and "active," allowing for 
  // the system to generate logs and observe behavior without making actual changes.
  bool is_dry_run = 10;

  // ... 
}

Use cases

Improved documentation

Alternatives and workarounds

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    part:❓We need to figure out which part is affectedpriority:❓We need to figure out how soon this should be addressedtype:enhancementNew feature or enhancement visitble to users

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions