Skip to content

Commit

Permalink
Merge pull request #218 from solarwinds/NH-66995-move-org-and-repo
Browse files Browse the repository at this point in the history
NH-66995 Updates after moving org and repo
  • Loading branch information
tammy-baylis-swi authored Nov 10, 2023
2 parents 9ec9afb + 184773b commit 33f4278
Show file tree
Hide file tree
Showing 8 changed files with 145 additions and 149 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build_publish_pypi_and_draft_release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ jobs:
aws-secret-access-key: ${{ secrets.API_CI_GHA_SECRET_ACCESS_KEY }}
aws-region: us-east-1
- id: launch
uses: solarwindscloud/ec2-runner-action@main
uses: solarwinds/ec2-runner-action@main
with:
action: launch
github-token: ${{ steps.github-token.outputs.token }}
Expand Down Expand Up @@ -114,7 +114,7 @@ jobs:
aws-access-key-id: ${{ secrets.API_CI_GHA_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.API_CI_GHA_SECRET_ACCESS_KEY }}
aws-region: us-east-1
- uses: solarwindscloud/ec2-runner-action@main
- uses: solarwinds/ec2-runner-action@main
with:
action: terminate
github-token: ${{ steps.github-token.outputs.token }}
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/build_publish_testpypi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ jobs:
aws-secret-access-key: ${{ secrets.API_CI_GHA_SECRET_ACCESS_KEY }}
aws-region: us-east-1
- id: launch
uses: solarwindscloud/ec2-runner-action@main
uses: solarwinds/ec2-runner-action@main
with:
action: launch
github-token: ${{ steps.github-token.outputs.token }}
Expand Down Expand Up @@ -100,7 +100,7 @@ jobs:
aws-access-key-id: ${{ secrets.API_CI_GHA_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.API_CI_GHA_SECRET_ACCESS_KEY }}
aws-region: us-east-1
- uses: solarwindscloud/ec2-runner-action@main
- uses: solarwinds/ec2-runner-action@main
with:
action: terminate
github-token: ${{ steps.github-token.outputs.token }}
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/verify_install.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ jobs:
aws-secret-access-key: ${{ secrets.API_CI_GHA_SECRET_ACCESS_KEY }}
aws-region: us-east-1
- id: launch
uses: solarwindscloud/ec2-runner-action@main
uses: solarwinds/ec2-runner-action@main
with:
action: launch
matrix: |
Expand Down Expand Up @@ -266,7 +266,7 @@ jobs:
aws-access-key-id: ${{ secrets.API_CI_GHA_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.API_CI_GHA_SECRET_ACCESS_KEY }}
aws-region: us-east-1
- uses: solarwindscloud/ec2-runner-action@main
- uses: solarwinds/ec2-runner-action@main
with:
action: terminate
github-token: ${{ steps.github-token.outputs.token }}
Expand Down
242 changes: 121 additions & 121 deletions CHANGELOG.md

Large diffs are not rendered by default.

6 changes: 1 addition & 5 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
* @solarwindscloud/eng-apm-instrumentation

# prepare for move to solarwinds
* @solarwinds/eng-pub-apm-instrumentation

* @solarwinds/eng-pub-apm-instrumentation
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to solarwinds-apm-python
# Contributing to Python solarwinds-apm

Thank you for contributing and helping us improve `solarwinds-apm-python`.
Thank you for contributing and helping us improve Python `solarwinds-apm`.

----

Expand All @@ -12,12 +12,12 @@ Please report any security issues privately to the SolarWinds Product Security I

### All other issues

For non-security issues, please submit your ideas, questions, or problems as [GitHub issues](https://github.com/solarwindscloud/solarwinds-apm-python/issues). Please add as much information as you can, such as: Python version, platform, installed dependencies and their version numbers, hosting, code examples or gists, steps to reproduce, stack traces, and logs. SolarWinds project maintainers may ask for clarification or more context after submission.
For non-security issues, please submit your ideas, questions, or problems as [GitHub issues](https://github.com/solarwinds/apm-python/issues). Please add as much information as you can, such as: Python version, platform, installed dependencies and their version numbers, hosting, code examples or gists, steps to reproduce, stack traces, and logs. SolarWinds project maintainers may ask for clarification or more context after submission.

----
## Contributing

Any changes to this project must be made through a pull request to `main`. Major changes should be linked to an existing [GitHub issue](https://github.com/solarwindscloud/solarwinds-apm-python/issues). Smaller contributions like typo corrections don't require an issue.
Any changes to this project must be made through a pull request to `main`. Major changes should be linked to an existing [GitHub issue](https://github.com/solarwinds/apm-python/issues). Smaller contributions like typo corrections don't require an issue.

A PR is ready to merge when all tests pass, any major feedback has been resolved, and at least one SolarWinds maintainer has approved. Once ready, a PR can be merged by a SolarWinds maintainer.

Expand Down Expand Up @@ -61,7 +61,7 @@ make tox OPTIONS="--recreate -e py38-ao-prod"
make tox OPTIONS="-- tests/integration/test_scenario_1.py"
```

The unit and integration tests are also run on GitHub with the [Run tox tests](https://github.com/solarwindscloud/solarwinds-apm-python/actions/workflows/run_tox_tests.yaml) workflow.
The unit and integration tests are also run on GitHub with the [Run tox tests](https://github.com/solarwinds/apm-python/actions/workflows/run_tox_tests.yaml) workflow.

### Formatting and Linting

Expand All @@ -79,16 +79,16 @@ make tox OPTIONS="-e lint -- --check-only"
make tox OPTIONS="-e lint"
```

Remotely, CodeQL can be run on GitHub with the [CodeQL Analysis](https://github.com/solarwindscloud/solarwinds-apm-python/actions/workflows/codeql_analysis.yaml) workflow.
Remotely, CodeQL can be run on GitHub with the [CodeQL Analysis](https://github.com/solarwinds/apm-python/actions/workflows/codeql_analysis.yaml) workflow.

### Install locally and instrument a test app

`solarwinds-apm-python` can be installed and used to instrument a Python app running on your local:
`solarwinds-apm` can be installed and used to instrument a Python app running on your local:

1. Create and run a Docker build container as described above.
2. Inside the build container: `make wrapper`. This downloads the version of a C/C++ dependency defined in `extension/VERSION` from SolarWinds Cloud and builds SWIG bindings.
3. In your Python app's environment/container, install your local `solarwinds-apm`. For example, if you've saved it to `~/gitrepos` then you could do:
```pip install -Ie ~/gitrepos/solarwinds-apm-python/```
```pip install -Ie ~/gitrepos/apm-python/```
4. Install all relevant Opentelemetry Python instrumentation libraries:
```opentelemetry-bootstrap --action=install```
5. Run your application with the prefix `opentelemetry-instrument` to wrap all common Python frameworks:
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
[![PyPI version](https://badge.fury.io/py/solarwinds-apm.svg)](https://badge.fury.io/py/solarwinds-apm) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/solarwinds-apm) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg?color=red)](https://github.com/solarwindscloud/solarwinds-apm-python/blob/main/LICENSE)
[![PyPI version](https://badge.fury.io/py/solarwinds-apm.svg)](https://badge.fury.io/py/solarwinds-apm) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/solarwinds-apm) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg?color=red)](https://github.com/solarwinds/apm-python/blob/main/LICENSE)

# solarwinds-apm-python
# Python solarwinds-apm
An [OpenTelemetry Python](https://opentelemetry-python.readthedocs.io/) distribution for SolarWinds Observability. Provides automatic configuration, instrumentation, and APM data export for Python applications.

----
## Requirements
All published artifacts support Python 3.7 or higher. A full list of system requirements is available at [SolarWinds Observability System Requirements](https://documentation.solarwinds.com/en/success_center/observability/default.htm#cshid=app-sysreqs-python-agent).

See [CONTRIBUTING.md](https://github.com/solarwindscloud/solarwinds-apm-python/blob/main/CONTRIBUTING.md) for how to build for development.
See [CONTRIBUTING.md](https://github.com/solarwinds/apm-python/blob/main/CONTRIBUTING.md) for how to build for development.

## Getting Started
SolarWinds APM captures OpenTelemetry distributed traces and metrics from your application and sends them to SolarWinds Observability for analysis and visualization.

To install `solarwinds-apm-python` and all relevant Opentelemetry Python instrumentation libraries:
To install `solarwinds-apm` and all relevant Opentelemetry Python instrumentation libraries:
```
pip install solarwinds-apm
opentelemetry-bootstrap --action=install
```

`solarwinds_apm` already includes OpenTelemetry and therefore doesn't need to be installed separately. Python agent installation should be done _after_ installation of all other service dependencies. This is so `opentelemetry-bootstrap` detects those packages and installs their corresponding instrumentation libraries. For example:
`solarwinds-apm` already includes OpenTelemetry and therefore doesn't need to be installed separately. Python agent installation should be done _after_ installation of all other service dependencies. This is so `opentelemetry-bootstrap` detects those packages and installs their corresponding instrumentation libraries. For example:

```
pip install -r requirements.txt # installs all other dependencies
Expand Down Expand Up @@ -60,8 +60,8 @@ Online documentation for SolarWinds APM Python features, configuration, and more

OpenTelemetry Python would not be possible without collaborations and efforts from many contributors. Our common goals as a community are to improve end user/developer experiences and empower them.

For more information about contributing to `solarwinds-apm-python`, see [CONTRIBUTING.md](https://github.com/solarwindscloud/solarwinds-apm-python/blob/main/CONTRIBUTING.md). Thank you to everyone who has contributed:
For more information about contributing to Python `solarwinds-apm`, see [CONTRIBUTING.md](https://github.com/solarwinds/apm-python/blob/main/CONTRIBUTING.md). Thank you to everyone who has contributed:

<a href="https://github.com/solarwindscloud/solarwinds-apm-python/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=solarwindscloud/solarwinds-apm-python" />
<a href="https://github.com/solarwinds/apm-python/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=solarwinds/apm-python" />
</a>
2 changes: 1 addition & 1 deletion tests/docker/install/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Installation tests

These files provide containers and scripts to test installation of packaged `solarwinds-apm-python`, from local or from registry. Here is how to set up and run install tests locally:
These files provide containers and scripts to test installation of packaged `solarwinds-apm`, from local or from registry. Here is how to set up and run install tests locally:

1. Set test mode to install from one of:
* `export MODE=local` (default; must be built in project `dist/`)
Expand Down

0 comments on commit 33f4278

Please sign in to comment.