feat(cisco-dis)

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "restructuredtext.confPath": ""
+}

README.md

@@ -1 +1,46 @@
-# otel-fso-launcher
+# otel-py
+
+[![Apache License][license-image]][license-image]
+
+Alpha version
+
+This package provides a Cisco Launcher for OpenTelemetry python
+
+## Installation
+
+pip
+
+```sh
+pip install cisco-otel-py
+```
+
+poetry
+```sh
+poetry add cisco-otel-py
+```
+
+## Usage
+```python
+from cisco_otel_py import trace
+
+trace.init()
+```
+
+## Configuration
+
+Advanced options can be configured as a parameter to the init() method:
+
+| Parameter       | Env                    | Type    | Default       | Description                                                       |
+| --------------- | ---------------------- | ------- | ------------- | ----------------------------------------------------------------- |
+| ciscoToken      | CISCO_TOKEN            | string  | -             | Cisco account token                                               |
+| serviceName     | OTEL_SERVICE_NAME      | string  | `application` | Application name that will be set for traces                      |
+| debug           | CISCO_DEBUG            | string  | `false`       | Debug logs                                                        |
+| payloadsEnabled | CISCO_PAYLOADS_ENABLED | boolean | `false`       | The number in bytes of the maximum payload to capture for request |
+| maxPayloadSize  | CISCO_MAX_PAYLOAD_SIZE | number  | `1024`        | The number in bytes of the maximum payload to capture for request |
+
+Exporter options
+
+| Parameter         | Env                     | Type   | Default                 | Description                                                                                                                                         |
+| ----------------- | ----------------------- | ------ | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| collectorEndpoint | OTEL_COLLECTOR_ENDPOINT | string | `http://localhost:4317` | The address of the trace collector to send traces to                                                                                                |
+| type.             | OTEL_EXPORTER_TYPE      | string | `otlp-grpc`             | The exporter type to use (Currently `otlp-grpc`, `otlp-http` are supported). Multiple exporter option available via init function see example below |

otel_fso_launcher/__init__.py → cisco_otel_py/__init__.py

@@ -14,6 +14,7 @@
 limitations under the License.
 """
 
+
 from .trace import init
 
 __version__ = '0.1.0'

otel_fso_launcher/cmd/__init__.py → cisco_otel_py/cmd/__init__.py

@@ -12,4 +12,4 @@
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-"""
+"""

cisco_otel_py/cmd/bootstrap.py

@@ -0,0 +1,21 @@
+"""
+Copyright The Cisco Authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from opentelemetry.instrumentation.bootstrap import run as otel_bootstrap
+
+
+def run() -> None:
+    otel_bootstrap()

cisco_otel_py/cmd/trace.py

@@ -0,0 +1,26 @@
+"""
+Copyright The Cisco Authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from opentelemetry.instrumentation.bootstrap import run as otel_bootstrap
+from opentelemetry.instrumentation.auto_instrumentation import run as otel_run
+
+
+def run() -> None:
+    otel_run()
+
+
+def boot() -> None:
+    otel_bootstrap()

otel_fso_launcher/sample.py → cisco_otel_py/sample.py

@@ -13,8 +13,10 @@
 See the License for the specific language governing permissions and
 limitations under the License.
 """
+
 import trace
 
+
 def start():
     """short sanity"""
     trace.init()

otel_fso_launcher/trace.py → cisco_otel_py/trace.py

@@ -13,6 +13,7 @@
 See the License for the specific language governing permissions and
 limitations under the License.
 """
+
 import os
 
 from opentelemetry import trace
@@ -23,7 +24,7 @@
     ConsoleSpanExporter,
 )
 from pkg_resources import iter_entry_points
-from otel_fso_launcher import consts
+from cisco_otel_py import consts
 
 
 def init() -> TracerProvider:

pyproject.toml

@@ -1,13 +1,16 @@
 [tool.poetry]
-name = "otel-py"
+name = "cisco-otel-py"
 version = "0.1.0"
-description = ""
-authors = ["SDK <[email protected]>"]
+description = "a minimal python Cisco Launcher for OpenTelemetry"
+license = "Apache-2.0"
+authors = ["Cisco Epsagon Team <[email protected]>"]
+readme = readme.md
+repository = "https://github.com/epsagon/otel-py"
 
 [tool.poetry.scripts]
-otel-py = 'otel_fso_launcher.cmd.trace:run'
-otel-py-bootstrap = 'otel_fso_launcher.cmd.bootstrap:run'
-otel-py-boot = 'otel_fso_launcher.cmd.trace:boot'
+otel-py = 'cisco_otel_py.cmd.trace:run'
+otel-py-bootstrap = 'cisco_otel_py.cmd.bootstrap:run'
+otel-py-boot = 'cisco_otel_py.cmd.trace:boot'
 
 [tool.poetry.dependencies]
 python = "^3.9"

tests/test_otel_fso_launcher.py → tests/cisco_opentelemetry_py.py

@@ -14,7 +14,8 @@
 limitations under the License.
 """
 
-import otel_fso_launcher
+import cisco_otel_py
+
 
 def test_version():
-    assert otel_fso_launcher.__version__ == '0.1.0'
+    assert cisco_otel_py.__version__ == '0.1.0'