From b2a742b96d391fe7dfcaaf4b6df19d6c55279351 Mon Sep 17 00:00:00 2001 From: "Dementiev, Roman" Date: Fri, 3 May 2024 10:23:24 +0200 Subject: [PATCH] change opcm -> intel pointers where applicable Change-Id: I5eab47f10b4530473eb85c4bbe58b7857bd3db9e --- README.md | 8 ++++---- doc/DOCKER_README.md | 6 +++--- doc/PCM-EXPORTER.md | 6 +++--- docker-compose.yml | 2 +- pcm-kubernetes.yaml.experimental | 2 +- pcm.spec | 2 +- scripts/grafana/README.md | 2 +- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 0d449bba..7fdb4c83 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ PCM provides a number of command-line utilities for real-time monitoring: - **pcm-sensor-server** : pcm collector exposing metrics over http in JSON or Prometheus (exporter text based) format ([how-to](doc/PCM-EXPORTER.md)). Also available as a [docker container](doc/DOCKER_README.md). More info about Global PCM events is [here](doc/PCM-SENSOR-SERVER-README.md). - **pcm-memory** : monitor memory bandwidth (per-channel and per-DRAM DIMM rank) -![pcm-memory output](https://raw.githubusercontent.com/wiki/opcm/pcm/pcm-memory.x.JPG) +![pcm-memory output](https://raw.githubusercontent.com/wiki/intel/pcm/pcm-memory.x.JPG) - **pcm-accel** : [monitor Intel® In-Memory Analytics Accelerator (Intel® IAA), Intel® Data Streaming Accelerator (Intel® DSA) and Intel® QuickAssist Technology (Intel® QAT) accelerators](doc/PCM_ACCEL_README.md) ![image](https://user-images.githubusercontent.com/25432609/218480696-42ade94f-e0c3-4000-9dd8-39a0e75a210e.png) @@ -40,7 +40,7 @@ PCM provides a number of command-line utilities for real-time monitoring: - **pcm-pcie** : monitor PCIe bandwidth per-socket - **pcm-iio** : monitor PCIe bandwidth per PCIe device -![pcm-iio output](https://raw.githubusercontent.com/wiki/opcm/pcm/pcm-iio.png) +![pcm-iio output](https://raw.githubusercontent.com/wiki/intel/pcm/pcm-iio.png) - **pcm-numa** : monitor local and remote memory accesses - **pcm-power** : monitor sleep and energy states of processor, Intel(r) Quick Path Interconnect, DRAM memory, reasons of CPU frequency throttling and other energy-related metrics - **pcm-tsx**: monitor performance metrics for Intel(r) Transactional Synchronization Extensions @@ -50,7 +50,7 @@ PCM provides a number of command-line utilities for real-time monitoring: Graphical front ends: - **pcm Grafana dashboard** : front-end for Grafana (in [scripts/grafana](scripts/grafana) directory). Full Grafana Readme is [here](scripts/grafana/README.md) -![pcm grafana output](https://raw.githubusercontent.com/wiki/opcm/pcm/pcm-dashboard.png) +![pcm grafana output](https://raw.githubusercontent.com/wiki/intel/pcm/pcm-dashboard.png) - **pcm-sensor** : front-end for KDE KSysGuard - **pcm-service** : front-end for Windows perfmon @@ -65,7 +65,7 @@ Building PCM Tools Clone PCM repository with submodules: ``` -git clone --recursive https://github.com/opcm/pcm.git +git clone --recursive https://github.com/intel/pcm.git ``` or clone the repository first, and then update submodules with: diff --git a/doc/DOCKER_README.md b/doc/DOCKER_README.md index 896ccec7..ed38f7ed 100644 --- a/doc/DOCKER_README.md +++ b/doc/DOCKER_README.md @@ -4,11 +4,11 @@ How To Run Intel(r) Performance Counter Monitor Server Container from GitHub Con As root user: 1. ``modprobe msr`` -2. ``docker run -d --name pcm --privileged -p 9738:9738 ghcr.io/opcm/pcm`` (GitHub Container repository) or ``docker run -d --name pcm --privileged -p 9738:9738 opcm/pcm`` (Dockerhub repository) - - the container can also be run with limited capabilities without the privileged mode: ``docker run -d --name pcm --cap-add=SYS_ADMIN --cap-add=SYS_RAWIO --device=/dev/cpu --device=/dev/mem -v /sys/firmware/acpi/tables/MCFG:/pcm/sys/firmware/acpi/tables/MCFG:ro -v /proc/bus/pci/:/pcm/proc/bus/pci/ -v /proc/sys/kernel/nmi_watchdog:/pcm/proc/sys/kernel/nmi_watchdog -v /sys:/sys:rw -p 9738:9738 ghcr.io/opcm/pcm`` (there is also a docker-compose file containing these options: https://raw.githubusercontent.com/opcm/pcm/master/docker-compose.yml) +2. ``docker run -d --name pcm --privileged -p 9738:9738 ghcr.io/intel/pcm`` (GitHub Container repository) or ``docker run -d --name pcm --privileged -p 9738:9738 opcm/pcm`` (Dockerhub repository) + - the container can also be run with limited capabilities without the privileged mode: ``docker run -d --name pcm --cap-add=SYS_ADMIN --cap-add=SYS_RAWIO --device=/dev/cpu --device=/dev/mem -v /sys/firmware/acpi/tables/MCFG:/pcm/sys/firmware/acpi/tables/MCFG:ro -v /proc/bus/pci/:/pcm/proc/bus/pci/ -v /proc/sys/kernel/nmi_watchdog:/pcm/proc/sys/kernel/nmi_watchdog -v /sys:/sys:rw -p 9738:9738 ghcr.io/intel/pcm`` (there is also a docker-compose file containing these options: https://raw.githubusercontent.com/intel/pcm/master/docker-compose.yml) This will start pcm-sensor-server container exposing CPU metrics from the whole system at port 9738 The URLs of the docker container repositories: -- https://github.com/opcm/pcm/pkgs/container/pcm +- https://github.com/intel/pcm/pkgs/container/pcm - https://hub.docker.com/r/opcm/pcm diff --git a/doc/PCM-EXPORTER.md b/doc/PCM-EXPORTER.md index 4c14d609..63efc0b6 100644 --- a/doc/PCM-EXPORTER.md +++ b/doc/PCM-EXPORTER.md @@ -4,8 +4,8 @@ pcm-sensor-server is a collector exposing Intel processor metrics over http in JSON or Prometheus (exporter text based) format. Also [available as a docker container](DOCKER_README.md). Installation on target system to be analyzed: -1. [Build](https://github.com/opcm/pcm#building-pcm-tools) or [download](https://github.com/opcm/pcm#downloading-pre-compiled-pcm-tools) pcm tools -2. As root, start pcm-sensor-server: `sudo ./pcm-sensor-server` or as non-root https://github.com/intel-innersource/applications.analyzers.pcm#executing-pcm-tools-under-non-root-user-on-linux +1. [Build](https://github.com/intel/pcm#building-pcm-tools) or [download](https://github.com/intel/pcm#downloading-pre-compiled-pcm-tools) pcm tools +2. As root, start pcm-sensor-server: `sudo ./pcm-sensor-server` or as non-root https://github.com/intel/pcm#executing-pcm-tools-under-non-root-user-on-linux Alternatively one can start [pcm-sensor-server as a container from docker hub](DOCKER_README.md). @@ -33,4 +33,4 @@ The default output of pcm-sensor-server endpoint in a browser: The PCM exporter can be used together with Grafana to obtain these Intel processor metrics (see [how-to](../scripts/grafana/README.md)): -![pcm grafana output](https://raw.githubusercontent.com/wiki/opcm/pcm/pcm-dashboard-full.png) +![pcm grafana output](https://raw.githubusercontent.com/wiki/intel/pcm/pcm-dashboard-full.png) diff --git a/docker-compose.yml b/docker-compose.yml index c353af2d..52505f2b 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,7 +1,7 @@ version: '2.0' services: pcm: - image: opcm/pcm + image: ghcr.io/intel/pcm:latest ports: - "9738:9738" volumes: diff --git a/pcm-kubernetes.yaml.experimental b/pcm-kubernetes.yaml.experimental index f4426d11..f08452f8 100644 --- a/pcm-kubernetes.yaml.experimental +++ b/pcm-kubernetes.yaml.experimental @@ -37,7 +37,7 @@ spec: spec: automountServiceAccountToken: false containers: - - image: ghcr.io/opcm/pcm:latest + - image: ghcr.io/intel/pcm:latest env: - name: PCM_NO_MSR value: "1" diff --git a/pcm.spec b/pcm.spec index eb0ecf53..997329ea 100644 --- a/pcm.spec +++ b/pcm.spec @@ -5,7 +5,7 @@ Release: 0 Summary: Intel(r) Performance Counter Monitor Group: System/Monitoring License: BSD-3-Clause -Url: https://github.com/opcm/pcm/archive +Url: https://github.com/intel/pcm/archive Source: master.zip BuildRoot: %{_tmppath}/%{name}-%{version}-build AutoReqProv: on diff --git a/scripts/grafana/README.md b/scripts/grafana/README.md index ac0c6fde..3ff848ca 100644 --- a/scripts/grafana/README.md +++ b/scripts/grafana/README.md @@ -33,4 +33,4 @@ Installation of the grafana front-end (can be on any *host* system with connecti 5. You can also stop and delete the containers when needed: `sudo sh stop.sh` -![pcm grafana output](https://raw.githubusercontent.com/wiki/opcm/pcm/pcm-dashboard-full.png) +![pcm grafana output](https://raw.githubusercontent.com/wiki/intel/pcm/pcm-dashboard-full.png)