Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add explanation of statistics system Comunica #57

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

RubenEschauzier
Copy link
Contributor

No description provided.

Copy link
Member

@rubensworks rubensworks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, very useful to have this here!

const QueryEngine = require('@comunica/query-sparql').QueryEngine;
const engine = new QueryEngine();

const query: string = " .... "
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be useful if we had a complete working example here.


```typescript
statistic.on((data) => {
// Do something here
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you give an example of what could be done with this data?
To clarify what data is.

As the query executes, Comunica **emits these metrics in real time**, enabling other (future) Comunica actors to adaptively optimize query processing.
After query completion, these statistics can be analyzed to gain insights into execution behavior and performance characteristics.

## Link Discovery and Dereference Events
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can precede this title by saying something like "The available types of statistics are described in more detail below".

```
The `wraps` field on the `ActorIteratorTransformRecordIntermediateResults` indicates which query operations or joins will be wrapped.
In the example, intermediate results for inner, minus, and optional joins will be recorded, in addition to the final project result.
These intermediate results are produced and emitted by `StatisticIntermediateResults`, which should be included in the context in the same manner as `StatisticLinkDiscovery` and `StatisticLinkDereference`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can give a brief example of this as well?

@rubensworks
Copy link
Member

Maybe we can also move this one to the modify docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants