diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index dd59cc70e..2a960c343 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -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 diff --git a/README.md b/README.md index 0e41b9c25..1e5b57a44 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 diff --git a/docs/gauntlet.md b/docs/gauntlet.md index 693e943da..43a45ed7b 100644 --- a/docs/gauntlet.md +++ b/docs/gauntlet.md @@ -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 diff --git a/src/main/java/org/opensearch/performanceanalyzer/rca/README.md b/src/main/java/org/opensearch/performanceanalyzer/rca/README.md index 8c2d61c90..5299c743f 100644 --- a/src/main/java/org/opensearch/performanceanalyzer/rca/README.md +++ b/src/main/java/org/opensearch/performanceanalyzer/rca/README.md @@ -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 ### diff --git a/src/main/java/org/opensearch/performanceanalyzer/rca/store/rca/temperature/README.md b/src/main/java/org/opensearch/performanceanalyzer/rca/store/rca/temperature/README.md index b2ee91d90..99be728bc 100644 --- a/src/main/java/org/opensearch/performanceanalyzer/rca/store/rca/temperature/README.md +++ b/src/main/java/org/opensearch/performanceanalyzer/rca/store/rca/temperature/README.md @@ -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 diff --git a/src/main/java/org/opensearch/performanceanalyzer/reader_writer_shared/EventLogFileHandler.java b/src/main/java/org/opensearch/performanceanalyzer/reader_writer_shared/EventLogFileHandler.java index 4b403d5f5..53494030e 100644 --- a/src/main/java/org/opensearch/performanceanalyzer/reader_writer_shared/EventLogFileHandler.java +++ b/src/main/java/org/opensearch/performanceanalyzer/reader_writer_shared/EventLogFileHandler.java @@ -82,9 +82,8 @@ public void writeTmpFile(List dataEntries, long epoch) { * data. * *

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. */ diff --git a/src/test/java/org/opensearch/performanceanalyzer/rca/integTests/framework/annotations/AMetric.java b/src/test/java/org/opensearch/performanceanalyzer/rca/integTests/framework/annotations/AMetric.java index 4a1be613c..35c4ec88f 100644 --- a/src/test/java/org/opensearch/performanceanalyzer/rca/integTests/framework/annotations/AMetric.java +++ b/src/test/java/org/opensearch/performanceanalyzer/rca/integTests/framework/annotations/AMetric.java @@ -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