Skip to content

Conversation

@maryann-macrometa
Copy link
Contributor

Apologies for the misleading branch name. I made some changes to VWRs.

@vercel
Copy link

vercel bot commented Jun 10, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Jun 19, 2024 0:31am

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

👍

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

👍


## The VWR Workflow

During moments of peak traffic, VWRs makes a new page separate from your origin to organize visitors. The VWRs workflow ensures that users are directed to the appropriate origin service while ensuring fairness in the queue and providing metrics and alerts to the administrator.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't understand "makes a new page". What do you mean?


During moments of peak traffic, VWRs makes a new page separate from your origin to organize visitors. The VWRs workflow ensures that users are directed to the appropriate origin service while ensuring fairness in the queue and providing metrics and alerts to the administrator.

1. The Akamai EdgeWorkers check the virtual room service to confirm if a waiting room is set up for an origin service
Copy link
Contributor

Choose a reason for hiding this comment

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

There is only one EdgeWorker. So is "EdgeWorkers" still correct? Below it is singular.

"check the virtual room service"... Do you "check the virtual room service" or "check with the virtual room service"?

Did you mean to call it "virtual room service" and not "virtual waiting room service"?

- If no waiting room, the EdgeWorker sends the traffic request directly to the origin service.
- If there is a waiting room, the EdgeWorker sends to the waiting room.

3. The waiting room service adds the request to the waiting room associated with the domain.
Copy link
Contributor

Choose a reason for hiding this comment

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

I am confused about "domain". Is this the old nomenclature "domain" or is this a different domain?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think it's okay for this to stay as-is.


## FIFO

This FIFO (first in, first out) queue operates on a "first come, first served" basis. Every new request pushes older requests to the front of the queue, closer to the origin server. Thus, when the system removes a request from the front, all subsequent elements move up one position.
Copy link
Contributor

Choose a reason for hiding this comment

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

What is "this" referencing?


## Available Metrics

The metrics response body includes the following properties:
Copy link
Contributor

Choose a reason for hiding this comment

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

"response body" ?? I think this is about an REST API, but there was no reference to a REST API.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's a response to an API call. I'll make it clearer in my next commit

maryann-macrometa and others added 2 commits June 11, 2024 16:45
Co-authored-by: Joubert Berger <88400412+joubert-macrometa@users.noreply.github.com>
Co-authored-by: Joubert Berger <88400412+joubert-macrometa@users.noreply.github.com>
maryann-macrometa and others added 2 commits June 11, 2024 16:58
Co-authored-by: Joubert Berger <88400412+joubert-macrometa@users.noreply.github.com>
Co-authored-by: Joubert Berger <88400412+joubert-macrometa@users.noreply.github.com>
Implemented some edits
Copy link
Contributor

@todor-macrometa todor-macrometa left a comment

Choose a reason for hiding this comment

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

Don't feel bad about the large number of comments, VWRS is a bit rough around the edges. Seven services, deprecated parts, unimplemented parts, EdgeWorkers, CDNs, oh my 😄

…ting-rooms.md

Co-authored-by: Todor <153493191+todor-macrometa@users.noreply.github.com>
…ting-rooms.md

Co-authored-by: Joubert Berger <88400412+joubert-macrometa@users.noreply.github.com>
Copy link
Contributor

@todor-macrometa todor-macrometa left a comment

Choose a reason for hiding this comment

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

See suggestions.


```bash
curl -X 'PATCH' \
https://api-vwr-service.gdn-akamai.com/api/vwr/v1/origins/example3.com \
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
https://api-vwr-service.gdn-akamai.com/api/vwr/v1/origins/example3.com \
https://api-vwr-service.gdn-akamai.com/api/vwr/v1/waitingrooms/example3.com \


- The waiting room service periodically checks the sessions to remove requests for expired sessions from the queues.
- The waiting room service collects the metrics for each waiting room.
- The administrator can turn customer domains on or off through Configuration APIs.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- The administrator can turn customer domains on or off through Configuration APIs.
- The administrator can turn customer waiting rooms on or off through Configuration APIs.

- If no waiting room, the EdgeWorker sends the traffic request directly to the origin service.
- If there is a waiting room, the EdgeWorker sends to the waiting room.

3. The waiting room service adds the request to the waiting room associated with the domain.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it's okay for this to stay as-is.

Co-authored-by: Todor <153493191+todor-macrometa@users.noreply.github.com>
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.

4 participants