Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
eeliu committed Aug 5, 2024
1 parent b2c6d2e commit 4195125
Show file tree
Hide file tree
Showing 7 changed files with 71 additions and 27 deletions.
2 changes: 2 additions & 0 deletions DOC/PHP/Readme-CN.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[English](Readme.md) | [中文](Readme-CN.md) | [한국어](Readme-KR.md)

## 安装参照

### 依赖组件
Expand Down
2 changes: 2 additions & 0 deletions DOC/PHP/Readme-KR.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[English](Readme.md) | [中文](Readme-CN.md) | [한국어](Readme-KR.md)

## 시작 가이드

### 요구
Expand Down
2 changes: 2 additions & 0 deletions DOC/PHP/Readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[English](Readme.md) | [中文](Readme-CN.md) | [한국어](Readme-KR.md)

## Supported

[pinpoint-apm/pinpoint-php-aop#supported-librariesframework ](https://github.com/pinpoint-apm/pinpoint-php-aop?tab=readme-ov-file#supported-librariesframework)
Expand Down
2 changes: 2 additions & 0 deletions DOC/PY/Readme-CN.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[English](Readme.md) | [中文](Readme-CN.md) | [한국어](Readme-KR.md)

# pinpoint-py agent 使用说明

## 入门指南
Expand Down
2 changes: 2 additions & 0 deletions DOC/PY/Readme-KR.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[English](Readme.md) | [中文](Readme-CN.md) | [한국어](Readme-KR.md)

# pinpoint-py agent 가이드

## 시작 가이드
Expand Down
5 changes: 3 additions & 2 deletions DOC/PY/Readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Tutorial for pinpoint-py agent
[English](Readme.md) | [中文](Readme-CN.md) | [한국어](Readme-KR.md)


## Getting Started

Expand All @@ -15,7 +16,7 @@
$ pip install pinpointPy
```

### How to Use
### Choose your framework


#### 1.1 Flask
Expand Down
83 changes: 58 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,92 @@
![pinpoint](images/logo.png)

[![CI](https://github.com/pinpoint-apm/pinpoint-c-agent/actions/workflows/main.yml/badge.svg)](https://github.com/pinpoint-apm/pinpoint-c-agent/actions/workflows/main.yml) [![Gitter](https://badges.gitter.im/naver/pinpoint-c-agent.svg)](https://gitter.im/naver/pinpoint-c-agent?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![codecov](https://codecov.io/gh/pinpoint-apm/pinpoint-c-agent/branch/master/graph/badge.svg?token=KswbmFvWp3)](https://codecov.io/gh/pinpoint-apm/pinpoint-c-agent) [![License](https://img.shields.io/github/license/pinpoint-apm/pinpoint-c-agent)](LICENSE)

[![CI](https://github.com/pinpoint-apm/pinpoint-c-agent/actions/workflows/main.yml/badge.svg)](https://github.com/pinpoint-apm/pinpoint-c-agent/actions/workflows/main.yml) [![Gitter](https://badges.gitter.im/naver/pinpoint-c-agent.svg)](https://gitter.im/naver/pinpoint-c-agent?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![codecov](https://codecov.io/gh/pinpoint-apm/pinpoint-c-agent/branch/master/graph/badge.svg?token=KswbmFvWp3)](https://codecov.io/gh/pinpoint-apm/pinpoint-c-agent) [![License](https://img.shields.io/github/license/pinpoint-apm/pinpoint-c-agent)](LICENSE) \
`pinpoint_php_ext:` [![pinpoint_php](https://img.shields.io/badge/php-7.1~8.3-8892BF)](https://pecl.php.net/package/pinpoint_php)\
`pinpoint-php-aop:` ![Packagist License](https://img.shields.io/packagist/l/pinpoint-apm/pinpoint-php-aop)
[![Total Downloads](https://img.shields.io/packagist/dt/pinpoint-apm/pinpoint-php-aop.svg?style=flat-square)](https://packagist.org/packages/pinpoint-apm/pinpoint-php-aop)\
`pinpointpy:` ![PyPI - License](https://img.shields.io/pypi/l/pinpointpy)
[![pypi](https://badge.fury.io/py/pinpointpy.svg)](https://pypi.org/project/pinpointpy/)
![PyPI - Downloads](https://img.shields.io/pypi/dm/pinpointpy)


**Visit [our official website](http://pinpoint-apm.github.io/pinpoint/) for more information and [the Latest updates on Pinpoint](https://pinpoint-apm.github.io/pinpoint/news.html)**


The current stable version is [the Latest](https://github.com/pinpoint-apm/pinpoint-c-agent/releases).
# Pinpoint `C` Agent

> What's `C`
1. Use `C/Cpp` common API
2. `C`ross-platform: windows/*nux/macOS
3. `C`llector-agent: a bridge to pinpoint-collector

Pinpoint C Agent helps your monitor your PHP/PYTHON applications into [pinpoint-apm](https://github.com/pinpoint-apm/pinpoint).\
Our advantage:
1. Continuous maintenance and optimization. (Since Jul 31,2018)
2. Auto-injection, that means less aggression against your code.
- python: leverage [PEP 318 Decorator](https://peps.python.org/pep-0318/)
- php: leverage `CG(*_table)` in php kernel and AST parser([nikic/PHP-Parser](https://github.com/nikic/PHP-Parser))
3. Cross-platform: windows/*nux/macOS. It helps address the problems even when you developing.

## Python Agent

> py 3.8+
`pip install pinpointPy`

[Full guide for python](DOC/PY/Readme.md)

# Pinpoint Agent
## PHP Agent

It is an agent written by C++, PHP and Python languages. And we hope to support other languages by this agent. Until now, it supports **_PHP_**, **_C/CPP_** and **_PYTHON_**.
> php 7.1+
## Overview Pinpoint Agent
1. Install extension

### How does it work
` pecl install pinpoint_php `

![How does it work](images/pinpoint_v0.5.x.png)
2. Import pinpoint aspect plugin

### Pinpoint Agent
`composer require pinpoint-apm/pinpoint-php-aop`

language| tutorial
---|---
php|[EN](DOC/PHP/Readme.md) [CN](DOC/PHP/Readme-CN.md) [KR](DOC/PHP/Readme-KR.md)
python3|[EN](DOC/PY/Readme.md) [CN](DOC/PY/Readme-CN.md) [KR](DOC/PY/Readme-KR.md)
c/cpp|[English](DOC/C-CPP/Readme.md)
[Full guide for PHP](DOC/PHP/Readme.md)

> [Try playground](/testapps/readme.md)
## C/CPP built in API

[Full guide for C](DOC/C-CPP/Readme.md)


## Our agent playground

`cd testapps && docker compose build --build-arg PHP_VERSION=7.4 && docker compose up`

[Tested project](/testapps/readme.md)

### Blogs

- Intro pinpoint php aop : https://github.com/pinpoint-apm/pinpoint-php-aop/wiki/Intro-pinpoint-php-aop
- pinpoint php aop 内部原理: https://github.com/pinpoint-apm/pinpoint-php-aop/wiki/pinpoint-php-aop-%E5%86%85%E9%83%A8%E5%8E%9F%E7%90%86
- pinpoint php aop 내부 원리: https://github.com/pinpoint-apm/pinpoint-php-aop/wiki/pinpoint-php-aop-%EB%82%B4%EB%B6%80-%EC%9B%90%EB%A6%AC
- [Intro pinpoint php aop](https://github.com/pinpoint-apm/pinpoint-php-aop/wiki/Intro-pinpoint-php-aop)
- [pinpoint php aop 内部原理](https://github.com/pinpoint-apm/pinpoint-php-aop/wiki/pinpoint-php-aop-%E5%86%85%E9%83%A8%E5%8E%9F%E7%90%86)
- [pinpoint php aop 내부 원리](https://github.com/pinpoint-apm/pinpoint-php-aop/wiki/pinpoint-php-aop-%EB%82%B4%EB%B6%80-%EC%9B%90%EB%A6%AC)


## Contact Us

* Submit an [issue](https://github.com/pinpoint-apm/pinpoint-c-agent/issues)
* Submit an [issue](https://github.com/pinpoint-apm/pinpoint-c-agent/issues) 👍👍
* [Email Us](mailto:dl_cd_pinpoint@navercorp.com) 👍👍
* [Gitter char room](https://gitter.im/naver/pinpoint-c-agent)
* dl_cd_pinpoint@navercorp.com
* Chinese Community (QQ Group: 882020485)
* QQ us (QQ Group: 882020485)
<details>
<summary> show more
</summary>

QQ Group1: 897594820 | QQ Group2: 812507584 | QQ Group3: 882020485| DING Group : 21981598
:----------------: |:----------------: | :-----------: | :-----------:
![QQ Group1](images/NAVERPinpoint.png) | ![QQ Group2](images/NAVERPinpoint2.png)| ![QQ Group3](images/NAVERPinpoint3.png)| ![DING Group](images/NaverPinpoint交流群-DING.jpg)

| QQ Group1: 897594820 | QQ Group2: 812507584 | QQ Group3: 882020485 | DING Group : 21981598 |
| :------------------------------------: | :-------------------------------------: | :-------------------------------------: | :------------------------------------------------: |
| ![QQ Group1](images/NAVERPinpoint.png) | ![QQ Group2](images/NAVERPinpoint2.png) | ![QQ Group3](images/NAVERPinpoint3.png) | ![DING Group](images/NaverPinpoint交流群-DING.jpg) |
</details>

## Contributing

Thanks all [![GitHub contributors](https://img.shields.io/github/contributors/pinpoint-apm/pinpoint-c-agent)](https://github.com/pinpoint-apm/pinpoint-c-agent/graphs/contributors)

We are looking forward to your contributions via pull requests.

## License
Expand Down

0 comments on commit 4195125

Please sign in to comment.