Add python agent release notes for 10.0.0 - PLEASE MERGE SEPTEMBER 27th 2024 AM #18735
Conversation
|
Hi @hmstepanek 👋 Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days. We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes). |
✅ Deploy Preview for docs-website-netlify ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
cbehera-newrelic
added
content
hmstepanek
force-pushed
the
python-10-0-0-release
branch
from
2501f4c to
7782366
Compare
hmstepanek
force-pushed
the
python-10-0-0-release
branch
from
7782366 to
4f010b5
Compare
There was a problem hiding this comment.
Thanks for putting together the release notes! I had a few tweaks, mostly nitpicky sentence structure stuff but there is also the gRPC/GraphQL question as well.
Also, should Python 2.7 have a space between "Python" and "2.7"? In code we definitely write it as one word, but I thought it was separated into two words when writing it text.
| @@ -0,0 +1,76 @@ | |||
| --- | |||
| subject: 'Python agent' | |||
| releaseDate: '2024-08-08' | |||
|
|
||
| ## Notes | ||
|
|
||
| This release of the Python agent drops support for Python2.7, adds a Kafka server metric, capturing of memcache host and port, support for [kafka-python-ng](https://pypi.org/project/kafka-python-ng/), support for [uvicorn_worker](https://pypi.org/project/uvicorn-worker/), an environment variable for GC runtime metrics, and automatically detects the function signature in [LangChain](https://pypi.org/project/langchain/) `similarity_search`. It also fixes a bug in [graphql](https://pypi.org/project/graphql/) entity name detection, an issue in [LangChain](https://pypi.org/project/langchain/) where a thread is started and the transaction context is lost, parsing of the request and response when running [OpenAI](https://pypi.org/project/openai/) via [LangChain](https://pypi.org/project/langchain/), [pyscopg](https://pypi.org/project/psycopg/) v3 API incompatibilities, and instruments a new path to the [OpenAI](https://pypi.org/project/openai/) chat class. |
There was a problem hiding this comment.
I think this is a big enough list that we should use bullet points. Something like this:
This release of the Python agent drops support for Python2.7 and adds the following:
- a Kafka server metric
hostandportattributes for memcache- support for kafka-python-ng
- support for uvicorn_worker
- an environment variable for garbage collector (GC) runtime metrics
- automatic detection for the function signature in LangChain's
similarity_search - updated support for OpenAI's chat class
- a fix for a bug in graphql's entity name detection
- a fix for transaction context propagation loss in LangChain in the case of a new thread
- parsing of the request and response when running OpenAI via LangChain
- a fix for pyscopg v3 API incompatibilities
|
|
||
| * Adds a metric to capture the host and port information for Kafka entities on both consumers and producers. This metric allows the UI to link AWS information with AWS MSK entities in the service map. | ||
|
|
||
| * Add capturing of memcache host and port |
There was a problem hiding this comment.
Use backticks on the words host and port since those are the actual attribute names
|
|
||
| * Add capturing of memcache host and port | ||
|
|
||
| * Adds capturing of host and port info on memcache libraries; bmemcached, aiomcache, and pymemcache. This allows the UI to link AWS information with AWS memcache entities in the service map. |
There was a problem hiding this comment.
We should use backticks on the words host and port but also, tweak the first sentence to say this:
Adds capturing of host and port info on the following memcache libraries: bmemcached, aiomcache, and pymemcache.
(changes made: backticks, colon to denote list instead of semicolon, and pypi links to libraries)
|
|
||
| * Add environment variable for GC runtime metrics | ||
|
|
||
| * GC runtime metircs can now be enabled/disabled via the following environment variable: NEW_RELIC_GC_RUNTIME_METRICS_ENABLED. |
There was a problem hiding this comment.
Should we write out the word "garbage collector" in the description? On the small chance that someone searching the docs might not realize immediately what GC is?
Also, we should add backticks to the environment variable name
|
|
||
| * Remove Python2.7 Support | ||
|
|
||
| * Removes compatibility with Python2.7. Also removes instrumentations that were only supported on Python2.7. |
|
|
||
| * Fix bug in graphql entity name detection | ||
|
|
||
| * Previously, the graphql channel entity name would be missing the first couple characters. This bug has been fixed. |
There was a problem hiding this comment.
Is this the PR this is referencing: newrelic/newrelic-python-agent#1206 if so, this is gRPC and we should change that in the summary, metadata, and this section
Assuming this is for gRPC, let's change the sentence to something like this:
Previously, the gRPC channel entity name was missing the first character(s) in specific cases. This bug has been fixed.
There was a problem hiding this comment.
OMG Yes that is the PR and I'm special.
|
|
||
| * Instrument new path to [OpenAI](https://pypi.org/project/openai/) chat class | ||
|
|
||
| * [OpenAI](https://pypi.org/project/openai/) moved the ChatCompletions class to a different path which prevented the instrumentation from being applied. This has been fixed. |
There was a problem hiding this comment.
Add backticks to ChatCompletions class name
|
|
||
| * GC runtime metircs can now be enabled/disabled via the following environment variable: NEW_RELIC_GC_RUNTIME_METRICS_ENABLED. | ||
|
|
||
| ## Deprecations |
There was a problem hiding this comment.
Can we move this section to come first before New Features since it is most important for this release?
|
|
||
| ## Notes | ||
|
|
||
| This release of the Python agent drops support for Python2.7, adds a Kafka server metric, capturing of memcache host and port, support for [kafka-python-ng](https://pypi.org/project/kafka-python-ng/), support for [uvicorn_worker](https://pypi.org/project/uvicorn-worker/), an environment variable for GC runtime metrics, and automatically detects the function signature in [LangChain](https://pypi.org/project/langchain/) `similarity_search`. It also fixes a bug in [graphql](https://pypi.org/project/graphql/) entity name detection, an issue in [LangChain](https://pypi.org/project/langchain/) where a thread is started and the transaction context is lost, parsing of the request and response when running [OpenAI](https://pypi.org/project/openai/) via [LangChain](https://pypi.org/project/langchain/), [pyscopg](https://pypi.org/project/psycopg/) v3 API incompatibilities, and instruments a new path to the [OpenAI](https://pypi.org/project/openai/) chat class. |
There was a problem hiding this comment.
It looks like Python2.7 is officially written out as Python 2.7 with a space between the language and version so we may want to update that throughout these release notes: (ex: https://www.python.org/download/releases/2.7/)
| @@ -0,0 +1,76 @@ | |||
| --- | |||
There was a problem hiding this comment.
I added one more PR into this release since it's a bug fix for a customer so we will want to add that into the release notes as well. Here's the PR: newrelic/newrelic-python-agent#1222
| releaseDate: '2024-08-08' | ||
| version: 10.0.0 | ||
| downloadLink: 'https://pypi.python.org/pypi/newrelic' | ||
| features: ['Remove Python2.7 support', 'Add Kafka server metric', 'Add capturing of memcache host and port', 'Add support for kafka-python-ng', 'Add support for uvicorn_workers', 'Automatically detect function signature in LangChasimilarity search', 'Add environment variable for GC runtime metrics'] |
There was a problem hiding this comment.
| features: ['Remove Python2.7 support', 'Add Kafka server metric', 'Add capturing of memcache host and port', 'Add support for kafka-python-ng', 'Add support for uvicorn_workers', 'Automatically detect function signature in LangChasimilarity search', 'Add environment variable for GC runtime metrics'] | |
| features: ['Remove Python2.7 support', 'Add Kafka server metric', 'Add capturing of memcache host and port', 'Add support for kafka-python-ng', 'Add support for uvicorn_workers', 'Automatically detect function signature in LangChain similarity search', 'Add environment variable for GC runtime metrics'] |
| releaseDate: '2024-09-26' | ||
| version: 10.0.0 | ||
| downloadLink: 'https://pypi.python.org/pypi/newrelic' | ||
| features: ['Remove Python 2.7 support', 'Add Kafka server metric', 'Add capturing of memcache host and port', 'Add support for kafka-python-ng', 'Add support for uvicorn_workers', 'Automatically detect function signature in LangChasimilarity search', 'Add environment variable for GC runtime metrics'] |
There was a problem hiding this comment.
| features: ['Remove Python 2.7 support', 'Add Kafka server metric', 'Add capturing of memcache host and port', 'Add support for kafka-python-ng', 'Add support for uvicorn_workers', 'Automatically detect function signature in LangChasimilarity search', 'Add environment variable for GC runtime metrics'] | |
| features: ['Remove Python 2.7 support', 'Add Kafka server metric', 'Add capturing of memcache host and port', 'Add support for kafka-python-ng', 'Add support for uvicorn_workers', 'Automatically detect function signature in LangChain similarity search', 'Add environment variable for garbage collection runtime metrics'] |
|
|
||
| * Fix issue in [LangChain](https://pypi.org/project/langchain/) where a thread is started and the transaction context is lost | ||
|
|
||
| * Previously, when calling some chains like retreival chains, the transaction would be lost and instrumentation would be broken because a thread would be started by [LangChain](https://pypi.org/project/langchain/). This has been fixed so the transaction context is passed across threads and instrumentation still works for retreival chains. |
There was a problem hiding this comment.
| * Previously, when calling some chains like retreival chains, the transaction would be lost and instrumentation would be broken because a thread would be started by [LangChain](https://pypi.org/project/langchain/). This has been fixed so the transaction context is passed across threads and instrumentation still works for retreival chains. | |
| * Previously, when calling some chains like retrieval chains, the transaction would be lost and instrumentation would be broken because a thread would be started by [LangChain](https://pypi.org/project/langchain/). This has been fixed so the transaction context is passed across threads and instrumentation still works for retrieval chains. |
src/content/docs/release-notes/agent-release-notes/python-release-notes/python-agent-100000.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Uma Annamalai <[email protected]>
hmstepanek
changed the title
hmstepanek
changed the title
Give us some context