Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor Firestore Hooks #879

Merged
merged 3 commits into from
Jul 27, 2023
Merged

Refactor Firestore Hooks #879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e07ffc3
Remove unnecessary instrumentation
TimPansino Jul 24, 2023
ba7850a
Simplify existing instrumentation
TimPansino Jul 24, 2023
19f5a48
Remove unnecessary settings lookups
TimPansino Jul 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions newrelic/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2269,18 +2269,6 @@ def _process_module_builtin_defaults():
"instrument_graphql_validate",
)

_process_module_definition(
"google.cloud.firestore_v1.base_document",
"newrelic.hooks.datastore_firestore",
"instrument_google_cloud_firestore_v1_base_document",
)

_process_module_definition(
"google.cloud.firestore_v1.base_collection",
"newrelic.hooks.datastore_firestore",
"instrument_google_cloud_firestore_v1_base_collection",
)

_process_module_definition(
"google.cloud.firestore_v1.document",
"newrelic.hooks.datastore_firestore",
Expand Down
89 changes: 21 additions & 68 deletions newrelic/hooks/datastore_firestore.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,25 +18,6 @@
from newrelic.common.async_wrapper import generator_wrapper
from newrelic.api.datastore_trace import DatastoreTrace

_firestore_document_commands = (
"create",
"delete",
"get",
"set",
"update",
)
_firestore_document_generator_commands = (
"collections",
)

_firestore_collection_commands = (
"add",
"get",
)
_firestore_collection_generator_commands = (
"stream",
"list_documents"
)

_get_object_id = lambda obj, *args, **kwargs: obj.id

Expand All @@ -60,57 +41,29 @@ def instrument_google_cloud_firestore_v1_base_client(module):
)


def instrument_google_cloud_firestore_v1_base_collection(module):
for name in _firestore_collection_commands:
if hasattr(module.BaseCollectionReference, name) and not getattr(getattr(module.BaseCollectionReference, name), "_nr_wrapped", False):
wrap_datastore_trace(
module, "BaseCollectionReference.%s" % name, product="Firestore", target=_get_object_id, operation=name
)
getattr(module.BaseCollectionReference, name)._nr_wrapped = True

for name in _firestore_collection_generator_commands:
if hasattr(module.BaseCollectionReference, name) and not getattr(getattr(module.BaseCollectionReference, name), "_nr_wrapped", False):
wrap_generator_method(module, "BaseCollectionReference", name)
getattr(module.BaseCollectionReference, name)._nr_wrapped = True


def instrument_google_cloud_firestore_v1_collection(module):
for name in _firestore_collection_commands:
if hasattr(module.CollectionReference, name) and not getattr(getattr(module.CollectionReference, name), "_nr_wrapped", False):
wrap_datastore_trace(
module, "CollectionReference.%s" % name, product="Firestore", target=_get_object_id, operation=name
)
getattr(module.CollectionReference, name)._nr_wrapped = True
if hasattr(module, "CollectionReference"):
class_ = module.CollectionReference
for method in ("add", "get"):
if hasattr(class_, method):
wrap_datastore_trace(
module, "CollectionReference.%s" % method, product="Firestore", target=_get_object_id, operation=method
)

for name in _firestore_collection_generator_commands:
if hasattr(module.CollectionReference, name) and not getattr(getattr(module.CollectionReference, name), "_nr_wrapped", False):
wrap_generator_method(module, "CollectionReference", name)
getattr(module.CollectionReference, name)._nr_wrapped = True


def instrument_google_cloud_firestore_v1_base_document(module):
for name in _firestore_document_commands:
if hasattr(module.BaseDocumentReference, name) and not getattr(getattr(module.BaseDocumentReference, name), "_nr_wrapped", False):
wrap_datastore_trace(
module, "BaseDocumentReference.%s" % name, product="Firestore", target=_get_object_id, operation=name
)
getattr(module.BaseDocumentReference, name)._nr_wrapped = True

for name in _firestore_document_generator_commands:
if hasattr(module.BaseDocumentReference, name) and not getattr(getattr(module.BaseDocumentReference, name), "_nr_wrapped", False):
wrap_generator_method(module, "BaseDocumentReference", name)
getattr(module.BaseDocumentReference, name)._nr_wrapped = True
for method in ("stream", "list_documents"):
if hasattr(class_, method):
wrap_generator_method(module, "CollectionReference", method)


def instrument_google_cloud_firestore_v1_document(module):
for name in _firestore_document_commands:
if hasattr(module.DocumentReference, name) and not getattr(getattr(module.DocumentReference, name), "_nr_wrapped", False):
wrap_datastore_trace(
module, "DocumentReference.%s" % name, product="Firestore", target=_get_object_id, operation=name
)
getattr(module.DocumentReference, name)._nr_wrapped = True

for name in _firestore_document_generator_commands:
if hasattr(module.DocumentReference, name) and not getattr(getattr(module.DocumentReference, name), "_nr_wrapped", False):
wrap_generator_method(module, "DocumentReference", name)
getattr(module.DocumentReference, name)._nr_wrapped = True
if hasattr(module, "DocumentReference"):
class_ = module.DocumentReference
for method in ("create", "delete", "get", "set", "update"):
if hasattr(class_, method):
wrap_datastore_trace(
module, "DocumentReference.%s" % method, product="Firestore", target=_get_object_id, operation=method
)

for method in ("collections",):
if hasattr(class_, method):
wrap_generator_method(module, "DocumentReference", method)
5 changes: 0 additions & 5 deletions tests/datastore_firestore/test_collections.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,12 @@

from newrelic.api.time_trace import current_trace
from newrelic.api.datastore_trace import DatastoreTrace
from testing_support.db_settings import firestore_settings
from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics
from newrelic.api.background_task import background_task
from testing_support.validators.validate_database_duration import (
validate_database_duration,
)

DB_SETTINGS = firestore_settings()[0]
FIRESTORE_HOST = DB_SETTINGS["host"]
FIRESTORE_PORT = DB_SETTINGS["port"]


def _exercise_firestore(collection):
collection.document("DoesNotExist")
Expand Down
5 changes: 0 additions & 5 deletions tests/datastore_firestore/test_documents.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,12 @@

from newrelic.api.time_trace import current_trace
from newrelic.api.datastore_trace import DatastoreTrace
from testing_support.db_settings import firestore_settings
from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics
from newrelic.api.background_task import background_task
from testing_support.validators.validate_database_duration import (
validate_database_duration,
)

DB_SETTINGS = firestore_settings()[0]
FIRESTORE_HOST = DB_SETTINGS["host"]
FIRESTORE_PORT = DB_SETTINGS["port"]


def _exercise_firestore(collection):
italy_doc = collection.document("Italy")
Expand Down
Loading