Skip to content

Commit b77259a

Browse files
authored
docs: don't use open ended versions in supported technologies (#2479)
* docs: don't use open ended versions in supported technologies Also add missing entry for psycopg. * Fix a couple of nits
1 parent a1cfc99 commit b77259a

File tree

1 file changed

+46
-27
lines changed

1 file changed

+46
-27
lines changed

docs/reference/supported-technologies.md

Lines changed: 46 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -82,28 +82,28 @@ We support these Flask versions:
8282

8383
We support these aiohttp versions:
8484

85-
* 3.0+
85+
* 3.x
8686

8787

8888
### Tornado [supported-tornado]
8989

9090
We support these tornado versions:
9191

92-
* 6.0+
92+
* 6.x
9393

9494

9595
### Sanic [supported-sanic]
9696

9797
We support these sanic versions:
9898

99-
* 20.12.2+
99+
* >20.12.2,<26
100100
101101

102102
### Starlette/FastAPI [supported-starlette]
103103

104104
We support these Starlette versions:
105105

106-
* 0.13.0+
106+
* >0.13.0,<1
107107
108108
Any FastAPI version which uses a supported Starlette version should also be supported.
109109

@@ -112,7 +112,7 @@ Any FastAPI version which uses a supported Starlette version should also be supp
112112

113113
We support these `grpcio` versions:
114114

115-
* 1.24.0+
115+
* >1.24.0,<2
116116
117117

118118
## Automatic Instrumentation [automatic-instrumentation]
@@ -180,7 +180,7 @@ Collected trace data:
180180

181181
#### MySQLdb [automatic-instrumentation-db-mysql]
182182

183-
Library: `MySQLdb`
183+
Library: `MySQLdb` (`<2`)
184184

185185
Instrumented methods:
186186

@@ -195,7 +195,7 @@ Collected trace data:
195195

196196
#### mysql-connector [automatic-instrumentation-db-mysql-connector]
197197

198-
Library: `mysql-connector-python`
198+
Library: `mysql-connector-python` (`<9`)
199199

200200
Instrumented methods:
201201

@@ -210,7 +210,7 @@ Collected trace data:
210210

211211
#### pymysql [automatic-instrumentation-db-pymysql]
212212

213-
Library: `pymysql`
213+
Library: `pymysql` (`<2`)
214214

215215
Instrumented methods:
216216

@@ -225,7 +225,7 @@ Collected trace data:
225225

226226
#### aiomysql [automatic-instrumentation-db-aiomysql]
227227

228-
Library: `aiomysql`
228+
Library: `aiomysql` (`<1`)
229229

230230
Instrumented methods:
231231

@@ -236,9 +236,9 @@ Collected trace data:
236236
* parametrized SQL query
237237

238238

239-
#### PostgreSQL [automatic-instrumentation-db-postgres]
239+
#### PostgreSQL Psycopg2 [automatic-instrumentation-db-postgres]
240240

241-
Library: `psycopg2`, `psycopg2-binary` (`>=2.9`)
241+
Library: `psycopg2`, `psycopg2-binary` (`>=2.9,<3`)
242242

243243
Instrumented methods:
244244

@@ -250,10 +250,23 @@ Collected trace data:
250250

251251
* parametrized SQL query
252252

253+
#### PostgreSQL Psycopg [automatic-instrumentation-db-postgres-psycopg]
254+
255+
Library: `psycopg`, `psycopg-binary` (`>3.0.0,<4`)
256+
257+
Instrumented methods:
258+
259+
* `psycopg.connect`
260+
261+
The instrumented `connect` method returns a wrapped connection/cursor which instruments the actual `Cursor.execute` calls.
262+
263+
Collected trace data:
264+
265+
* parametrized SQL query
253266

254267
#### aiopg [automatic-instrumentation-db-aiopg]
255268

256-
Library: `aiopg` (`>=1.0`)
269+
Library: `aiopg` (`>=1.0,<2`)
257270

258271
Instrumented methods:
259272

@@ -267,7 +280,7 @@ Collected trace data:
267280

268281
#### asyncpg [automatic-instrumentation-db-asyncg]
269282

270-
Library: `asyncpg` (`>=0.20`)
283+
Library: `asyncpg` (`>=0.20,<2`)
271284

272285
Instrumented methods:
273286

@@ -281,7 +294,7 @@ Collected trace data:
281294

282295
#### PyODBC [automatic-instrumentation-db-pyodbc]
283296

284-
Library: `pyodbc`, (`>=4.0`)
297+
Library: `pyodbc` (`>=4.0,<6`)
285298

286299
Instrumented methods:
287300

@@ -296,7 +309,7 @@ Collected trace data:
296309

297310
#### MS-SQL [automatic-instrumentation-db-mssql]
298311

299-
Library: `pymssql`, (`>=2.1.0`)
312+
Library: `pymssql` (`>=2.1.0,<3`)
300313

301314
Instrumented methods:
302315

@@ -311,7 +324,7 @@ Collected trace data:
311324

312325
#### MongoDB [automatic-instrumentation-db-mongodb]
313326

314-
Library: `pymongo`, `>=2.9,<3.8`
327+
Library: `pymongo` (`>=2.9,<5`)
315328

316329
Instrumented methods:
317330

@@ -355,7 +368,7 @@ Collected trace data:
355368

356369
#### Redis [automatic-instrumentation-db-redis]
357370

358-
Library: `redis` (`>=2.8`)
371+
Library: `redis` (`>=2.8,<8`)
359372

360373
Instrumented methods:
361374

@@ -369,7 +382,7 @@ Collected trace data:
369382

370383
#### aioredis [automatic-instrumentation-db-aioredis]
371384

372-
Library: `aioredis` (`<2.0`)
385+
Library: `aioredis` (`<=2.0.1`)
373386

374387
Instrumented methods:
375388

@@ -398,7 +411,7 @@ Collected trace data:
398411

399412
#### Python Memcache [automatic-instrumentation-db-python-memcache]
400413

401-
Library: `python-memcached` (`>=1.51`)
414+
Library: `python-memcached` (`>=1.51,<2`)
402415

403416
Instrumented methods:
404417

@@ -429,7 +442,7 @@ Collected trace data:
429442

430443
#### pymemcache [automatic-instrumentation-db-pymemcache]
431444

432-
Library: `pymemcache` (`>=3.0`)
445+
Library: `pymemcache` (`>=3.0,<4.1`)
433446

434447
Instrumented methods:
435448

@@ -463,13 +476,13 @@ Collected trace data:
463476

464477
#### kafka-python [automatic-instrumentation-db-kafka-python]
465478

466-
Library: `kafka-python` (`>=2.0`)
479+
Library: `kafka-python` (`>=2.0,<3`)
467480

468481
Instrumented methods:
469482

470483
* `kafka.KafkaProducer.send`,
471484
* `kafka.KafkaConsumer.poll`,
472-
* `kafka.KafkaConsumer.\__next__`
485+
* `kafka.KafkaConsumer.__next__`
473486

474487
Collected trace data:
475488

@@ -482,11 +495,11 @@ Collected trace data:
482495

483496
#### Standard library [automatic-instrumentation-stdlib-urllib]
484497

485-
Library: `urllib2` (Python 2) / `urllib.request` (Python 3)
498+
Library: `urllib.request` (Python 3)
486499

487500
Instrumented methods:
488501

489-
* `urllib2.AbstractHTTPHandler.do_open` / `urllib.request.AbstractHTTPHandler.do_open`
502+
* `urllib.request.AbstractHTTPHandler.do_open`
490503

491504
Collected trace data:
492505

@@ -496,7 +509,7 @@ Collected trace data:
496509

497510
#### urllib3 [automatic-instrumentation-urllib3]
498511

499-
Library: `urllib3`
512+
Library: `urllib3` (`<3`)
500513

501514
Instrumented methods:
502515

@@ -517,6 +530,8 @@ Collected trace data:
517530

518531
#### requests [automatic-instrumentation-requests]
519532

533+
Library: `requests` (`<3`)
534+
520535
Instrumented methods:
521536

522537
* `requests.sessions.Session.send`
@@ -529,6 +544,8 @@ Collected trace data:
529544

530545
#### AIOHTTP Client [automatic-instrumentation-aiohttp-client]
531546

547+
Library: `aiohttp` (`>=3,<4`)
548+
532549
Instrumented methods:
533550

534551
* `aiohttp.client.ClientSession._request`
@@ -541,6 +558,8 @@ Collected trace data:
541558

542559
#### httpx [automatic-instrumentation-httpx]
543560

561+
Library: `httpx` (`<1`)
562+
544563
Instrumented methods:
545564

546565
* `httpx.Client.send
@@ -556,7 +575,7 @@ Collected trace data:
556575

557576
#### AWS Boto3 / Botocore [automatic-instrumentation-boto3]
558577

559-
Library: `boto3` (`>=1.0`)
578+
Library: `boto3` (`>=1.0,<2`)
560579

561580
Instrumented methods:
562581

@@ -573,7 +592,7 @@ Additionally, some services collect more specific data
573592

574593
#### AWS Aiobotocore [automatic-instrumentation-aiobotocore]
575594

576-
Library: `aiobotocore` (`>=2.2.0`)
595+
Library: `aiobotocore` (`>=2.2.0,<3`)
577596

578597
Instrumented methods:
579598

0 commit comments

Comments
 (0)