github.com/pinpoint-apm/pinpoint-go-agent@v1.4.1-0.20240110120318-a50c2eb18c8c/README.md (about)

     1  ![ci](https://github.com/pinpoint-apm/pinpoint-go-agent/workflows/ci/badge.svg)
     2  [![PkgGoDev](https://pkg.go.dev/badge/github.com/pinpoint-apm/pinpoint-go-agent)](https://pkg.go.dev/github.com/pinpoint-apm/pinpoint-go-agent)
     3  
     4  # Pinpoint Go Agent
     5  
     6  This is the official Go agent for [Pinpoint](https://github.com/pinpoint-apm/pinpoint).
     7  
     8  Pinpoint Go Agent enables you to monitor Go applications using Pinpoint.
     9  Go applications must be instrumented manually at the source code level,
    10  because Go is a compiled language and does not have a virtual machine like Java.
    11  Developers can instrument Go applications using the APIs provided in this package.
    12  
    13  ## Installation
    14  ```
    15  go get github.com/pinpoint-apm/pinpoint-go-agent
    16  ```
    17  
    18  ## Requirements
    19  * Go 1.15+
    20  * Pinpoint 2.1.1+
    21  * Linux, OS X, and Windows are supported.
    22  
    23  ## Getting Started
    24  
    25  Refer [Quick Start](doc/quick_start.md) for simple test run of Pinpoint Go Agent.
    26  
    27  ## Plug-ins
    28  Pinpoint Go Agent provides support for instrumenting Go’s built-in http package, database/sql drivers
    29  and plug-ins for popular frameworks and toolkits.
    30  These packages help you to make instruments with simple source code modifications.
    31  Refer the [Plugin User Guide](doc/plugin_guide.md) for more information.
    32  
    33  ## Documents
    34  * [Quick Start](doc/quick_start.md)
    35  * [Configuration](doc/config.md)
    36  * [Plugin User Guide](doc/plugin_guide.md)
    37  * [Custom Instrumentation](doc/instrument.md)
    38  * [Troubleshooting](doc/troubleshooting.md)
    39  
    40  ## Contributing
    41  
    42  We are looking forward to your contributions via pull requests.
    43  For tips on contributing code fixes or enhancements, please see the [contributing guide](CONTRIBUTING.md).
    44  To report bugs, please create an Issue on the GitHub repository. 
    45  
    46  ## License
    47  
    48  Pinpoint is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for full license text.