diff --git a/docs/src/en/SUMMARY.md b/docs/src/en/SUMMARY.md index e27e804..6fb6dfd 100644 --- a/docs/src/en/SUMMARY.md +++ b/docs/src/en/SUMMARY.md @@ -37,8 +37,9 @@ - [Test](dev-guide/test/README.md) - [Test scenes](dev-guide/test/test-scenes.md) - [Log](dev-guide/log/README.md) -- [Internals]() +- [Internals](dev-guide/internals/README.md) - [Log multiline](dev-guide/internals/log-multiline.md) + - [GPU](dev-guide/internals/gpu.md) # Operations - [Deployment]() diff --git a/docs/src/en/dev-guide/internals/README.md b/docs/src/en/dev-guide/internals/README.md new file mode 100644 index 0000000..2821005 --- /dev/null +++ b/docs/src/en/dev-guide/internals/README.md @@ -0,0 +1,2 @@ +# HoloInsight Internals +This directory contains HoloInsight internal details or uncategorized documentation. diff --git a/docs/src/en/dev-guide/internals/gpu.md b/docs/src/en/dev-guide/internals/gpu.md new file mode 100644 index 0000000..42aac7c --- /dev/null +++ b/docs/src/en/dev-guide/internals/gpu.md @@ -0,0 +1,43 @@ +# GPU +HoloInsight-Agent uses a query on the [nvidia-smi](https://developer.nvidia.com/nvidia-system-management-interface) binary to pull GPU stats including memory and GPU usage, temp and other. + +This GPU plugin is automatically activated if `nvidia-smi` is present. + +This plugin does not require any configuration. + +![GPU dashboard](../../../resources/images/dev-guide/internals/dashboard-gpu.png) +![GPU dashboard](../../../resources/images/dev-guide/internals/app-gpu.png) + +# nvidia-smi commands + +List all GPUs +```bash +nvidia-smi -L +``` + +Query GPU,memory utilization +```bash +nvidia-smi --query-gpu=index,utilization.gpu,utilization.memory --format=csv +``` + +> nvidia-smi --help-query-gpu + +Query memory usage +```bash +nvidia-smi --query-gpu=index,memory.used,memory.free,memory.total --format=csv +``` + +Query version and driver +```bash +nvidia-smi --query-gpu=index,name,vbios_version,driver_version --format=csv +``` + +Query temperature,power,clocks +```bash +nvidia-smi --query-gpu=index,power.draw,temperature.gpu,clocks.current.sm,clocks.current.memory,fan.speed --format=csv +``` + +Query GPU used memory of pids +```bash +nvidia-smi --query-compute-apps=gpu_uuid,pid,used_memory --format=csv +``` diff --git a/docs/src/resources/images/dev-guide/internals/app-gpu.png b/docs/src/resources/images/dev-guide/internals/app-gpu.png new file mode 100644 index 0000000..f4c3288 Binary files /dev/null and b/docs/src/resources/images/dev-guide/internals/app-gpu.png differ diff --git a/docs/src/resources/images/dev-guide/internals/dashboard-gpu.png b/docs/src/resources/images/dev-guide/internals/dashboard-gpu.png new file mode 100644 index 0000000..4b01680 Binary files /dev/null and b/docs/src/resources/images/dev-guide/internals/dashboard-gpu.png differ