More flexible logging options in RPC requests

Open
#4,209 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
haskell
Domain
api

Research direction

Start with the RPC request logging params described in this issue and review the sister issue in haskell-backend (#3655) for related decisions. Done means the logging schema is extensible through log-tags and the affected backends can choose whether to implement individual options.

Written by the indexing model from the issue text.

Description

pyk

In the Haskell team, we're working on providing fine-grained information on when kore-rpc-booster aborts in Booster and reverts to Kore. We will output this information on a per-request basis, as part of the "logs" field.

While for this use-case the current RPC log options are enough, we anticipate the need for additional RPC log options. To reduce friction with other backends (i.e. Maude) in future, we propose a schema change that would make the RPC log options extensible. Since RPC logs are not a part of the core backend functionality, every backend may choose whether or not to implement a particular log option.

Proposed change to request logging params:

Currently:

"log-successful-rewrites": bool, 
"log-failing-rewrites": bool, 
"log-successfule-simplifications": bool, 
"log-failing-simplifications": bool, 
...

After change:

"log-tags": [ "log-xxx-rewrites", "log-yyy-simplifications", ...]

The sister issue in haskell-backend: https://github.com/runtimeverification/haskell-backend/issues/3655

Dominant language
Python
Stars
591
Forks
163
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from runtimeverification/k

All issues in runtimeverification/k

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.