Skip to content

Commit acac105

Browse files
committed
generate readme fix
1 parent 773b98c commit acac105

File tree

5 files changed

+19
-8
lines changed

5 files changed

+19
-8
lines changed

instrumentation/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
| [opentelemetry-instrumentation-django](./opentelemetry-instrumentation-django) | django >= 1.10 | Yes | development
2323
| [opentelemetry-instrumentation-elasticsearch](./opentelemetry-instrumentation-elasticsearch) | elasticsearch >= 6.0 | No | development
2424
| [opentelemetry-instrumentation-falcon](./opentelemetry-instrumentation-falcon) | falcon >= 1.4.1, < 5.0.0 | Yes | migration
25-
| [opentelemetry-instrumentation-fastapi](./opentelemetry-instrumentation-fastapi) | fastapi ~= 0.92 | Yes | migration
25+
| [opentelemetry-instrumentation-fastapi](./opentelemetry-instrumentation-fastapi) | fastapi ~= 0.92,fastapi-slim ~= 0.92 | Yes | migration
2626
| [opentelemetry-instrumentation-flask](./opentelemetry-instrumentation-flask) | flask >= 1.0 | Yes | migration
2727
| [opentelemetry-instrumentation-grpc](./opentelemetry-instrumentation-grpc) | grpcio >= 1.42.0 | No | development
2828
| [opentelemetry-instrumentation-httpx](./opentelemetry-instrumentation-httpx) | httpx >= 0.18.0 | Yes | migration

instrumentation/opentelemetry-instrumentation-fastapi/src/opentelemetry/instrumentation/fastapi/package.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@
1313
# limitations under the License.
1414

1515

16-
_instruments = ("fastapi ~= 0.92",)
16+
# TODO: update this
17+
_instruments = ()
18+
_instruments_either = ("fastapi ~= 0.92", "fastapi-slim ~= 0.92")
1719

1820
_supports_metrics = True
1921

instrumentation/opentelemetry-instrumentation-kafka-python/src/opentelemetry/instrumentation/kafka/package.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@
1313
# limitations under the License.
1414

1515

16+
# TODO: where are these used?
1617
_instruments_kafka_python = "kafka-python >= 2.0, < 3.0"
1718
_instruments_kafka_python_ng = "kafka-python-ng >= 2.0, < 3.0"
1819

19-
_instruments = (_instruments_kafka_python, _instruments_kafka_python_ng)
20+
_instruments = ()
21+
_instruments_either = (_instruments_kafka_python, _instruments_kafka_python_ng)

instrumentation/opentelemetry-instrumentation-psycopg2/src/opentelemetry/instrumentation/psycopg2/package.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,13 @@
1313
# limitations under the License.
1414

1515

16+
# TODO: where are these used?
1617
_instruments_psycopg2 = "psycopg2 >= 2.7.3.1"
1718
_instruments_psycopg2_binary = "psycopg2-binary >= 2.7.3.1"
1819

19-
_instruments = (
20+
# TODO: maybe add _instruments_either
21+
_instruments = ()
22+
_instruments_either = (
2023
_instruments_psycopg2,
2124
_instruments_psycopg2_binary,
2225
)

scripts/generate_instrumentation_readme.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,19 +58,23 @@ def main(base_instrumentation_path):
5858
with open(version_filename, encoding="utf-8") as fh:
5959
exec(fh.read(), pkg_info)
6060

61-
instruments = pkg_info["_instruments"]
61+
instruments_and = pkg_info.get("_instruments", ())
62+
instruments_either = pkg_info.get("_instruments_either", ())
6263
supports_metrics = pkg_info.get("_supports_metrics")
6364
semconv_status = pkg_info.get("_semconv_status")
64-
if not instruments:
65-
instruments = (name,)
65+
instruments_all = ()
66+
if not instruments_and and not instruments_either:
67+
instruments_all = (name,)
68+
else:
69+
instruments_all = tuple(instruments_and + instruments_either)
6670

6771
if not semconv_status:
6872
semconv_status = "development"
6973

7074
metric_column = "Yes" if supports_metrics else "No"
7175

7276
table.append(
73-
f"| [{instrumentation}](./{instrumentation}) | {','.join(instruments)} | {metric_column} | {semconv_status}"
77+
f"| [{instrumentation}](./{instrumentation}) | {','.join(instruments_all)} | {metric_column} | {semconv_status}"
7478
)
7579

7680
with open(

0 commit comments

Comments
 (0)