[WIP] Pure python for reference; Don't merge #556

jerrytfleung · 2025-03-26T19:01:39Z

No description provided.

…ect otlp) (#549) * Set a baseline for pure python implementation * Update solarwinds_apm/api/__init__.py Co-authored-by: Tammy Baylis <[email protected]> * Update solarwinds_apm/configurator.py Co-authored-by: Tammy Baylis <[email protected]> * Update solarwinds_apm/exporter.py Co-authored-by: Tammy Baylis <[email protected]> --------- Co-authored-by: Tammy Baylis <[email protected]>

* NH-104997 - Python: apm-config to Sampler Configuration mapping

… context not baggage

…sor-redesign branch (#559) * Added Transaction Name calculation logic --------- Co-authored-by: tammy-baylis-swi <[email protected]> Co-authored-by: Tammy Baylis <[email protected]>

…tsettings NH-106059 Suppress tracing when HTTP getsettings

* Housekept spantype logic

NH-72398 Overhaul of default and SDK-set transaction naming for Pure Python and OTLP by default

github-advanced-security

CodeQL found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

NH-72398 Nit: Don't need to resolve `http.route` as txn name

…pi from init

NH-105013 Use more upstream NoOpXProvider

NH-104796 Fix init of pure Python Oboe counters

NH-104794 Simplify ResponseTime metrics, request counters for pure Python

NH-104796 Rename as ResponseTimeProcessor

NH-104999 Remove unused `oboe_api` from configurator, sampler init

NH-104999 Remove Inbound metrics span processor, merge base into ResponseTimeProcessor

…thon / OTLP-default (#569) * Removed calculate_otlp_transaction_name and considered SW_APM_TRANSACTION_NAME in serviceentry_processor * Update solarwinds_apm/trace/serviceentry_processor.py Co-authored-by: Tammy Baylis <[email protected]> * nits --------- Co-authored-by: Tammy Baylis <[email protected]>

NH-104999 Remove now-unused ApmConfig helpers, constants

NH-104999 Remove unused configuration keys

NH-102995 No-op SolarWindsSpanExporter

setup.py

+# def link_oboe_lib(src_lib):
+#     """Set up the C-extension library.
+#
+#     Creates a .so library symlink ('liboboe.so') needed when the
+#     solarwinds_apm package is built from source. This step is needed since Oboe library is platform specific.
+#
+#     The src_lib parameter is the name of the library file under solarwinds_apm/extension the above mentioned symlink will
+#     point to. If a file with the provided name does not exist, no symlinks will be created."""
+#
+#     logger.info("Create link to platform specific liboboe library file")
+#     link_dst = 'liboboe.so'
+#     cwd = os.getcwd()
+#     try:
+#         os.chdir('./solarwinds_apm/extension/')
+#         if not os.path.exists(src_lib):
+#             raise Exception("C-extension library file {} does not exist.".format(src_lib))
+#         if os.path.exists(link_dst):
+#             # if the destination library file exists already, it needs to be deleted, otherwise linking will fail
+#             os.remove(link_dst)
+#             logger.info("Removed %s" % link_dst)
+#         os.symlink(src_lib, link_dst)
+#         logger.info("Created new link at {} to {}".format(link_dst, src_lib))
+#     except Exception as ecp:
+#         logger.info("[SETUP] failed to set up link to C-extension library: {e}".format(e=ecp))
+#     finally:
+#         os.chdir(cwd)
+
+# class CustomBuild(build_py):
+#     def run(self):
+#         self.run_command('build_ext')
+#         build_py.run(self)
+#
+# class CustomBuildExt(build_ext):
+#     def run(self):
+#         # if sys.platform == 'darwin':
+#         #     return


The best way to fix the problem is to remove the commented-out code. This will improve code readability and maintainability. If the commented-out code is needed for future reference, it should be documented separately or added to version control comments.

Remove the commented-out function link_oboe_lib.

Remove the commented-out classes CustomBuild and CustomBuildExt.

Remove the commented-out ext_modules definition and the related cmdclass argument in the setup function.

solarwinds_apm/apm_oboe_codes.py

+# class OboeReadyCode:
+#     OBOE_SERVER_RESPONSE_UNKNOWN = (0, "Oboe server : unknown error")
+#     OBOE_SERVER_RESPONSE_OK = (1, "Oboe server : is ready")


The best way to fix the problem is to remove the commented-out code entirely if it is no longer needed. If the code is still relevant and should be part of the codebase, it should be reinstated. In this case, we will remove the commented-out code to clean up the codebase and avoid confusion.

solarwinds_apm/apm_oboe_codes.py

+#     def code_values(cls):
+#         code_pairs = [


The best way to fix the problem is to either remove the commented-out code entirely or reinstate it if it is still relevant and needed. In this case, we will remove the commented-out code to maintain a clean and readable codebase. This involves deleting the lines of commented-out code from the file solarwinds_apm/apm_oboe_codes.py.

solarwinds_apm/apm_oboe_codes.py

+# class OboeReporterCode:
+#     """Return values of Oboe Reporter"""
+#
+#     OBOE_INIT_ALREADY_INIT = -1
+#     OBOE_INIT_OK = 0
+#     OBOE_INIT_WRONG_VERSION = 1
+#     OBOE_INIT_INVALID_PROTOCOL = 2
+#     OBOE_INIT_NULL_REPORTER = 3
+#     OBOE_INIT_DESC_ALLOC = 4
+#     OBOE_INIT_FILE_OPEN_LOG = 5
+#     OBOE_INIT_UDP_NO_SUPPORT = 6
+#     OBOE_INIT_UDP_OPEN = 7
+#     OBOE_INIT_SSL_CONFIG_AUTH = 8
+#     OBOE_INIT_SSL_LOAD_CERT = 9
+#     OBOE_INIT_SSL_REPORTER_CREATE = 10
+#     OBOE_INIT_SSL_MISSING_KEY = 11
+#
+#     @classmethod
+#     def get_text_code(cls, num):
+#         """Returns the textual representation of the numerical status code."""
+#         for init_status, init_code in cls.__dict__.items():
+#             if init_code == num:
+#                 return init_status
+#         return None


To fix the problem, we should remove the commented-out code entirely. This will help in maintaining a clean and readable codebase. The removal should be done carefully to ensure that no necessary comments or documentation are accidentally deleted.

Identify the blocks of commented-out code.

Remove the lines containing the commented-out code.

Ensure that the remaining code is still functional and readable.

solarwinds_apm/configurator.py

+# if TYPE_CHECKING:
+#     from solarwinds_apm.extension.oboe import Event, OboeAPI, Reporter


To fix the problem, we should remove the commented-out code on lines 76-78. This will help in maintaining a clean and readable codebase. The removal of these lines will not affect the existing functionality of the code.