Skip to content

Commit

Permalink
Merge pull request opensearch-project#32 from khushbr/feature/documen…
Browse files Browse the repository at this point in the history
…tation-linking

Fixing the linker error, updating from docs-beta to official document…
  • Loading branch information
khushbr authored Jul 14, 2021
2 parents 862fc67 + 02fe515 commit 41d296a
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
id: lychee
uses: lycheeverse/lychee-action@master
with:
args: --accept=200,403,429 "**/*.html" "**/*.md" "**/*.txt"
args: --accept=200,403,429 --exclude=https://www.envoyproxy.io/ "**/*.html" "**/*.md" "**/*.txt"
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
- name: Fail if there were link errors
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![Java CI](https://github.com/opensearch-project/performance-analyzer-rca/workflows/Java%20CI/badge.svg)](https://github.com/opensearch-project/performance-analyzer-rca/actions?query=workflow%3A%22Java+CI%22)
[![codecov](https://codecov.io/gh/opensearch-project/performance-analyzer-rca/branch/main/graph/badge.svg)](https://codecov.io/gh/opensearch-project/performance-analyzer-rca)
[![Documentation](https://img.shields.io/badge/api-reference-blue.svg)](https://docs-beta.opensearch.org/monitoring-plugins/pa/reference/)
[![Documentation](https://img.shields.io/badge/api-reference-blue.svg)](https://opensearch.org/docs/monitoring-plugins/pa/reference/)
[![Chat](https://img.shields.io/badge/chat-on%20forums-blue)](https://discuss.opendistrocommunity.dev/c/performance-analyzer/)
![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success)

Expand Down Expand Up @@ -184,7 +184,7 @@ Please refer to the [Install Guide](./INSTALL.md) for detailed information on bu

## Documentation

Please refer to the [technical documentation](https://docs-beta.opensearch.org/monitoring-plugins/pa/index/) for detailed information on installing and configuring Performance Analyzer.
Please refer to the [technical documentation](https://opensearch.org/docs/monitoring-plugins/pa/index/) detailed information on installing and configuring Performance Analyzer.

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion docs/gauntlet.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Let's see an example:
metrics class that you specify, should have a `static final` field called `NAME` (`CPU_Utilization`)
and that will be used to determine the name of the metric table.
- _dimensionNames_ : For the dimension names for a metric, please refer to the docs
[here](https://docs-beta.opensearch.org/monitoring-plugins/pa/reference/). Each of the dimension
[here](https://opensearch.org/docs/monitoring-plugins/pa/reference/). Each of the dimension
will be a column in the rca.sqlite table.
- _tables_ : This specifies one or more table(s). The table should be a 5 second snapshot
of the metrics, similar to what exists in metricsdb files. The table is an array type
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ will run through the entirety of this discussion.
### Metrics ###
This is the input to the system. These are essentially key-value pairs. For
details on what metrics are available, please take a look at the online
reference [here](https://docs-beta.opensearch.org/monitoring-plugins/pa/reference/).
reference [here](https://opensearch.org/docs/monitoring-plugins/pa/reference/).

### Symptoms ###

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ node and cluster) based on resource utilization.
### Temperature RCA Graph construction
Temperature along each dimension is contributed by a shard-dependent and a shard-independent
components. For all the metrics
[here](https://docs-beta.opensearch.org/monitoring-plugins/pa/reference/), the metrics that
[here](https://opensearch.org/docs/monitoring-plugins/pa/reference/), the metrics that
have shardID as dimension will have a shard contributed factor to the temperature along that
dimension. But that metric also might have a factor that is shard independent. For example
, _CPU_utilization_, has a shard dependent components for the CPU that is spent for various
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,8 @@ public void writeTmpFile(List<Event> dataEntries, long epoch) {
* data.
*
* <p>If any of the above steps fail, then the tmp file is not deleted from the filesystem. This
* is fine as the {@link deleteFiles()}, will eventually clean it. The copies are atomic and
* therefore the reader never reads incompletely written file.
*
* is fine as the {@link org.opensearch.performanceanalyzer.reader_writer_shared.EventLogFileHandler#deleteFiles},
* will eventually clean it. The copies are atomic and therefore the reader never reads incompletely written file.
* @param dataEntries The metrics to be written to file.
* @param epoch The epoch all the metrics belong to.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
Class name();

// The names of the dimension columns that the metrics has. The dimensions can be found here:
// https://docs-beta.opensearch.org/docs/pa/reference/
// https://opensearch.org/docs/monitoring-plugins/pa/reference/
String[] dimensionNames();

// Specify one or more tables for the metric where each table belongs to a host or a group of
Expand Down

0 comments on commit 41d296a

Please sign in to comment.