Skip to content

Commit fde3d1e

Browse files
VasilenkovDenisDenis Vasilenkov
andauthored
Text refactoring (#57)
Co-authored-by: Denis Vasilenkov <denis.vasilenkov@gmonit.ru>
1 parent deda363 commit fde3d1e

4 files changed

Lines changed: 2 additions & 42 deletions

File tree

agent_installation_guide/APM/java.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
Для интеграции APM-агента в Java-приложение выполните следующие шаги:
44

5-
---
65

76
### 1. **Загрузка агента**
87
1. Скачайте архив с агентом с официального сайта New Relic:
@@ -13,7 +12,7 @@
1312

1413
2. (Опционально) Ознакомьтесь с [официальной инструкцией по установке APM-агента для Java](https://docs.newrelic.com/install/java/) для получения дополнительных подробностей.
1514

16-
---
15+
1716

1817
### 2. **Распаковка агента**
1918
Распакуйте загруженный архив в предпочтительный каталог. Например:
@@ -25,7 +24,7 @@ sudo unzip newrelic-java.zip -d /opt/newrelic
2524

2625
> **Важно:** Убедитесь, что файлы `.jar` агента **не находятся** в пути к классам или в каталогах, перечисленных в `java.endorsed.dirs`.
2726
28-
---
27+
2928

3029
### 3. **Настройка конфигурации агента**
3130
Настройте файл `newrelic.yml` или используйте переменные окружения для конфигурации агента.
@@ -53,7 +52,6 @@ sudo unzip newrelic-java.zip -d /opt/newrelic
5352
5453
> При необходимости более тонкой настройки параметров агента смотрите также официальную [документацию по конфигурации агента для Java](https://docs.newrelic.com/docs/apm/agents/java-agent/configuration/java-agent-configuration-config-file/).
5554
56-
---
5755
5856
### 4. **Интеграция агента с приложением**
5957
Добавьте флаг запуска агента в команду запуска вашего Java-приложения:
@@ -67,14 +65,11 @@ sudo unzip newrelic-java.zip -d /opt/newrelic
6765
java -javaagent:/opt/newrelic/newrelic.jar -jar my-app.jar
6866
```
6967

70-
---
71-
7268
### 5. **Проверка работы агента**
7369
После запуска приложения убедитесь, что агент успешно подключился:
7470
- В логах агента (`stdout`) должно появиться сообщение об успешном подключении.
7571
- В интерфейсе мониторинга GMonit появятся метрики приложения.
7672

77-
---
7873

7974
### 6. **Подробнее**
8075
Для более детальной информации о конфигурации и настройке агента обратитесь к [официальной документации New Relic](https://docs.newrelic.com/docs/apm/agents/java-agent/configuration/java-agent-configuration-config-file/).
@@ -84,7 +79,6 @@ java -javaagent:/opt/newrelic/newrelic.jar -jar my-app.jar
8479

8580
Для интеграции агента New Relic в Java-приложение, работающее в Kubernetes, выполните следующие шаги:
8681

87-
---
8882

8983
### Шаг 1: Загрузка и распаковка агента New Relic
9084

@@ -101,7 +95,6 @@ java -javaagent:/opt/newrelic/newrelic.jar -jar my-app.jar
10195

10296
> **Важно**: Если агент будет расположен в другом месте, убедитесь, что `.jar` файлы агента **не находятся** в директориях, указанных в `java.endorsed.dirs` или в пути к классам.
10397
104-
---
10598

10699
### Шаг 2: Настройка агента New Relic
107100

@@ -119,7 +112,6 @@ java -javaagent:/opt/newrelic/newrelic.jar -jar my-app.jar
119112
120113
2. Если используются самоподписанные сертификаты, убедитесь, что путь к бандлу сертификатов добавлен в настройки (см. предыдущие разделы).
121114
122-
---
123115
124116
### Шаг 3: Подготовка Docker-образа с агентом
125117
@@ -143,7 +135,4 @@ java -javaagent:/opt/newrelic/newrelic.jar -jar my-app.jar
143135
kind load docker-image my-java-app-with-newrelic:latest
144136
```
145137

146-
---
147-
148138
После выполнения этих шагов ваш Docker-образ с интегрированным APM-агентом готов для развертывания в Kubernetes. Убедитесь, что поды с приложением запускаются корректно, а метрики появляются в интерфейсе GMonit.
149-
```

agent_installation_guide/APM/nodejs.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
Для интеграции APM-агента New Relic в Node.js выполните следующие шаги:
44

5-
---
65

76
### 1. Установка пакета New Relic
87

@@ -15,7 +14,6 @@ npm install newrelic --save
1514
# Через Yarn
1615
yarn add newrelic
1716
```
18-
---
1917

2018
### 2. Копирование файла конфигурации
2119

@@ -25,8 +23,6 @@ yarn add newrelic
2523
cp ./node_modules/newrelic/newrelic.js ./<your-destination>
2624
```
2725

28-
---
29-
3026
### 3. Настройка файла конфигурации
3127

3228
Откройте скопированный файл `newrelic.js` и добавьте или измените следующие параметры:
@@ -39,7 +35,6 @@ exports.config = {
3935
};
4036
```
4137

42-
---
4338

4439
### 4. Запуск программы с модулем агента
4540

@@ -55,8 +50,6 @@ node -r newrelic your-program.js
5550
const newrelic = require('newrelic');
5651
```
5752

58-
---
59-
6053
### 5. Настройка для исключения установки модуля Native Metrics
6154

6255
В стандартной поставке включён модуль Node.js VM, который использует `gyp` и требует установленного Python для сборки бинарных файлов. Если Python отсутствует на хосте, вы можете исключить установку модуля Native Metrics, определив переменную окружения:
@@ -67,7 +60,6 @@ export NR_NATIVE_METRICS_NO_DOWNLOAD=true
6760

6861
Подробнее о Node.js VM и связанных измерениях можно найти в [документации New Relic](https://docs.newrelic.com/docs/apm/agents/nodejs-agent/extend-your-instrumentation/nodejs-vm-measurements/)
6962

70-
---
7163

7264
### Подробнее
7365

agent_installation_guide/APM/php.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66

77
Ниже собрана полная инструкция по установке и настройке данного агента в различных окружениях (Ubuntu/Debian, CentOS, контейнерные среды). Если требуется дополнительная информация, обращайтесь к [официальной документации](https://docs.newrelic.com/docs/apm/agents/php-agent/installation/php-agent-installation-overview).
88

9-
---
109

1110
### Обязательные настройки агента
1211

@@ -27,7 +26,6 @@ newrelic.logfile = stdout #Логирование агента в stdout
2726
> export NEW_RELIC_LOG=stdout #Логирование агента в stdout
2827
> ```
2928
30-
---
3129
3230
### 1. Установка агента New Relic для PHP на Ubuntu и Debian
3331
@@ -69,7 +67,6 @@ newrelic.logfile = stdout #Логирование агента в stdout
6967
6. **Проверка работы**
7068
Сгенерируйте трафик к вашему приложению и проверьте метрики в интерфейсе GMonit.
7169

72-
---
7370

7471
### 2. Установка агента New Relic для PHP на CentOS
7572

@@ -103,7 +100,6 @@ newrelic.logfile = stdout #Логирование агента в stdout
103100
6. **Проверка работы**
104101
Сгенерируйте трафик к вашему приложению и проверьте метрики в интерфейсе GMonit.
105102
106-
---
107103
108104
### 3. Установка агента New Relic для PHP в контейнерных средах (Docker и др.)
109105
@@ -147,7 +143,6 @@ newrelic.logfile = stdout #Логирование агента в stdout
147143
4. **Проверка работы**
148144
Сгенерируйте трафик к вашему приложению и проверьте метрики в интерфейсе GMonit.
149145

150-
---
151146

152147
### Дополнительная информация
153148

@@ -156,7 +151,6 @@ newrelic.logfile = stdout #Логирование агента в stdout
156151

157152
- Если требуются более тонкие настройки агента и прокси-демона (`newrelic-daemon`), в том числе указание кастомного `cafile`, использование дополнительных сетевых параметров и т. д., обратитесь к [разделу конфигурации демона](https://docs.newrelic.com/docs/apm/agents/php-agent/configuration/proxy-daemon-newreliccfg-settings/#proxy-settings).
158153

159-
---
160154

161155
# Добавление кастомного параметра
162156

@@ -198,7 +192,6 @@ newrelic_add_custom_parameter(string $key, scalar $value)
198192
199193
Для правильной идентификации и отслеживания транзакций в мониторинге вы можете задавать имена транзакций с помощью функции `newrelic_name_transaction`. Это позволяет организовать мониторинг и избежать избыточного числа уникальных имён транзакций, которые могут затруднить анализ данных.
200194
201-
---
202195
203196
#### Пример: Задание имени транзакции для `Uri/index.php`
204197
@@ -225,7 +218,6 @@ function example() {
225218
226219
Подробности можно найти в официальной документации [New Relic](https://docs.newrelic.com/docs/apm/agents/php-agent/php-agent-api/newrelic_name_transaction/)
227220
228-
---
229221
230222
### Пример: Добавление имени транзакции для конкретного URI
231223

agent_installation_guide/APM/python.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
Для установки и настройки Python-агента New Relic в Django выполните следующие шаги:
44

5-
---
65

76
### 1. Установка пакета New Relic
87

@@ -12,13 +11,11 @@
1211
pip install newrelic
1312
```
1413

15-
---
1614

1715
### 2. Настройка агента
1816

1917
Для начала работы агенту Python необходимы базовые настройки. Их можно задать двумя способами: через конфигурационный файл или переменные окружения.
2018

21-
---
2219

2320
#### Способ 1: Использование конфигурационного файла
2421

@@ -36,7 +33,6 @@ pip install newrelic
3633
app_name = "MY_AWESOME_APP" # Название приложения
3734
```
3835

39-
---
4036

4137
#### Способ 2: Использование переменных окружения
4238

@@ -48,19 +44,16 @@ NEW_RELIC_HOST=gmonit-collector.<DOMAIN>.ru # Домен коллектора
4844
NEW_RELIC_APP_NAME="MY_AWESOME_APP" # Название приложения
4945
```
5046

51-
---
5247

5348
### Подробнее
5449

5550
Для более детальной информации о конфигурации агента обратитесь к [официальной документации New Relic](https://docs.newrelic.com/install/python/).
5651

57-
---
5852

5953
# Установка Python-агента для FastAPI
6054

6155
Для установки и настройки Python-агента New Relic в FastAPI выполните следующие шаги:
6256

63-
---
6457

6558
### 1. Установка пакета New Relic
6659

@@ -70,13 +63,11 @@ NEW_RELIC_APP_NAME="MY_AWESOME_APP" # Название приложения
7063
pip install newrelic
7164
```
7265

73-
---
7466

7567
### 2. Настройка агента
7668

7769
Агенту Python необходимы базовые настройки. Их можно задать через конфигурационный файл или переменные окружения.
7870

79-
---
8071

8172
#### Способ 1: Использование конфигурационного файла
8273

@@ -94,7 +85,6 @@ pip install newrelic
9485
app_name = "MY_FAST_API_APP" # Название приложения
9586
```
9687

97-
---
9888

9989
#### Способ 2: Использование переменных окружения
10090

@@ -106,7 +96,6 @@ NEW_RELIC_HOST=gmonit-collector.<DOMAIN>.ru # Домен коллектора
10696
NEW_RELIC_APP_NAME= "MY_FAST_API_APP" # Название приложения
10797
```
10898

109-
---
11099

111100
### 3. Интеграция агента с FastAPI
112101

@@ -122,7 +111,6 @@ newrelic-admin run-program uvicorn main:app --host 0.0.0.0 --port 8000
122111
- **`--host 0.0.0.0`** — слушать на всех интерфейсах.
123112
- **`--port 8000`** — порт, на котором будет доступно ваше приложение.
124113

125-
---
126114

127115
#### Пример запуска приложения с Gunicorn:
128116

@@ -133,7 +121,6 @@ newrelic-admin run-program gunicorn main:app -w 4 -k uvicorn.workers.UvicornWork
133121
- **`-w 4`** — количество рабочих процессов.
134122
- **`-k uvicorn.workers.UvicornWorker`** — использование `UvicornWorker` для асинхронной обработки.
135123

136-
---
137124

138125
### Подробнее
139126

0 commit comments

Comments
 (0)