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.

Sign up for GitHub

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

Jump to bottom

SC-10203: Initial docs for private locations #305

Merged
merged 14 commits into from
Dec 18, 2020
Merged

SC-10203: Initial docs for private locations #305

merged 14 commits into from
Dec 18, 2020

Conversation

sivasamyk
Copy link
Contributor

No description provided.

otisg
otisg approved these changes Dec 17, 2020
View reviewed changes
Copy link
Member

@otisg otisg left a comment

Choose a reason for hiding this comment

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

LGTM, just monitor mods needed.

docs/synthetics/browser-monitor.md Outdated
@@ -39,6 +39,12 @@ By default, the UI adds the below conditions while creating a browser monitor. Y

The browser monitor script allows the collection of page screenshots at any point during the execution. This can be collected using [page.screenshot()](https://github.com/puppeteer/puppeteer/blob/master/docs/api.md#pagescreenshotoptions) Puppeteer API. JPEG and PNG image types are supported. Currently, the number of screenshots per run is limited to one. On failure of the script due to errors like navigation timeout, assertion failed, etc., a screenshot `error.png` will be collected for analysis.

## Console Errors

The browser logs any errors while loading the web pages such as javascript errors, network errors, etc in the browser console. The browser monitor collects these errors. These errors can be used to debug run failures. These errors are shown in the `Logs` section of run details.
Copy link
Member

Choose a reason for hiding this comment

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

etc => etc.
these errors. These errors => such errors. These errors
failures. These errors => failures and they

docs/synthetics/private-locations.md Outdated
@@ -0,0 +1,37 @@
title: Private Locations
description: Private locations allows you to monitor the APIs and webpages that are not accessible from the Internet such as your internal websites, private APIs, etc
Copy link
Member

Choose a reason for hiding this comment

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

Private locations allows => Private locations functionality allows
etc => etc.

docs/synthetics/private-locations.md Outdated
title: Private Locations
description: Private locations allows you to monitor the APIs and webpages that are not accessible from the Internet such as your internal websites, private APIs, etc

Private locations allow you to run the synthetics tests from your private network. Some of the use cases for using private locations are:
Copy link
Member

Choose a reason for hiding this comment

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

synthetics tests => synthetic tests

docs/synthetics/private-locations.md Outdated

* **Name** - Unique name for the private location
* **Description** - A brief description of the location
* **City** - Select the city where the machine running the agent is physically located. This is used to calculate latitude/longitude to plot the location in the map. If your city is not listed, select the nearest city.
Copy link
Member

Choose a reason for hiding this comment

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

This is used to calculate latitude/longitude to plot the location in the map. If your city is not listed, select the nearest city. => If your city is not listed, select the nearest city. This is used to calculate latitude/longitude to plot the location in the map.
(just swapping sentences, a little easier for reader to follow)

docs/synthetics/private-locations.md Outdated

## Install Private Agents

After creating the private location from UI, you need to install the agents on a machine in your private network. Private agents are deployed as Docker containers. There are two Docker images one for each HTTP & Browser monitor respectively.
Copy link
Member

Choose a reason for hiding this comment

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

There are two Docker images one for each HTTP & Browser monitor respectively.
=>
There are two Docker images, one for HTTP monitor and another for Browser monitor.

docs/synthetics/private-locations.md Outdated
## Install Private Agents

After creating the private location from UI, you need to install the agents on a machine in your private network. Private agents are deployed as Docker containers. There are two Docker images one for each HTTP & Browser monitor respectively.
You can deploy both agents or one based on your monitor types. Follow the instructions in the UI to install private agents in your network.
Copy link
Member

Choose a reason for hiding this comment

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

You can deploy both agents or one based on your monitor types

Not sure what you mean by "on your monitor types"?

Maybe this should be:
You can deploy either the HTTP or Browser monitor or both.
?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. I will change to "You can deploy either the HTTP or Browser monitor or both."

adnanrahic
adnanrahic suggested changes Dec 17, 2020
View reviewed changes
Copy link
Contributor

@adnanrahic adnanrahic left a comment

Choose a reason for hiding this comment

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

Just a few edits and some missing images.

docs/synthetics/private-locations.md Outdated

To create a private location, navigate to Synthetics -> Private Locations -> New Private Location.

![Create Private Location]()
Copy link
Contributor

Choose a reason for hiding this comment

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

No link?

docs/synthetics/private-locations.md Outdated
After creating the private location from UI, you need to install the agents on a machine in your private network. Private agents are deployed as Docker containers. There are two Docker images, one for HTTP monitor and another for Browser monitor.
You can deploy either the HTTP or Browser monitor or both. Follow the instructions in the UI to install private agents in your network.

![Agent Installation Instructions]()
Copy link
Contributor

Choose a reason for hiding this comment

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

No link?

docs/synthetics/private-locations.md Outdated

![Create Monitor with Private Location](../images/synthetics/private-locations-monitor.png)

![Monitor Overview with Private Location]()
Copy link
Contributor

Choose a reason for hiding this comment

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

No link?

Siva Kaliappan and others added 9 commits December 17, 2020 21:33
@sivasamyk sivasamyk merged commit 3e8bee5 into master Dec 18, 2020
@sivasamyk sivasamyk deleted the SC-10203 branch December 18, 2020 00:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adnanrahic adnanrahic adnanrahic requested changes

@otisg otisg otisg approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sivasamyk @otisg @adnanrahic