├── .circleci └── config.yml ├── .gitignore ├── LICENSE ├── README.md ├── appveyor.yml ├── backend.php ├── composer.json ├── frontend.php ├── functions.php └── screenshot.png /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: 2.1 2 | 3 | jobs: 4 | e2e: 5 | parameters: 6 | php-version: 7 | type: string 8 | zipkin-php-version: 9 | type: string 10 | docker: 11 | # node-browsers come with java pre-installed 12 | - image: cimg/php:<< parameters.php-version >>-browsers 13 | auth: 14 | username: $DOCKERHUB_USER 15 | password: $DOCKERHUB_PASSWORD 16 | working_directory: ~/zipkin-php-example 17 | steps: 18 | - checkout 19 | - run: 20 | name: Install Composer 21 | command: | 22 | php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');" 23 | php -r "if (hash_file('SHA384', 'composer-setup.php') === trim(file_get_contents('https://composer.github.io/installer.sig'))) { echo 'Installer verified'; } else { echo 'Installer invalid'; unlink('composer-setup.php'); } echo PHP_EOL;" 24 | php composer-setup.php 25 | php -r "unlink('composer-setup.php');" 26 | - run: composer require openzipkin/zipkin:"^<< parameters.zipkin-php-version >>" 27 | - run: composer install -n 28 | - run: curl -sSL https://zipkin.io/quickstart.sh | bash -s 29 | - run: 30 | background: true 31 | command: java -jar zipkin.jar 32 | # block until zipkin is available 33 | - run: wget --retry-connrefused -T 60 -O /dev/null http://127.0.0.1:9411/health 34 | # start both processes in the background, but don't use composer as it dies 35 | - run: 36 | background: true 37 | command: php -S '127.0.0.1:8081' frontend.php 38 | - run: 39 | background: true 40 | command: php -S '127.0.0.1:9000' backend.php 41 | # hit the frontend which calls the backend 42 | - run: wget -v --retry-connrefused -T 5 -O /dev/null 127.0.0.1:8081 43 | - run: | 44 | # wait just in case 45 | sleep 1 46 | test $(curl -s 127.0.0.1:9411/api/v2/traces | jq '.[0] | length') -eq 4 47 | 48 | workflows: 49 | version: 2 50 | nightly: 51 | triggers: 52 | - schedule: 53 | cron: "0 0 * * *" 54 | filters: 55 | branches: 56 | only: 57 | - master 58 | jobs: 59 | - e2e: 60 | context: 61 | - docker-hub-credentials 62 | matrix: 63 | parameters: 64 | php-version: ["7.4", "8.0", "8.1"] 65 | zipkin-php-version: ["3.0.0"] 66 | all-tests: 67 | jobs: 68 | - e2e: 69 | context: 70 | - docker-hub-credentials 71 | matrix: 72 | parameters: 73 | php-version: ["7.4", "8.0", "8.1"] 74 | zipkin-php-version: ["3.0.0"] 75 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | composer.phar 2 | composer.lock 3 | /vendor/ 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Zipkin PHP example 2 | 3 | [![CircleCI](https://circleci.com/gh/openzipkin/zipkin-php-example/tree/master.svg?style=svg)](https://circleci.com/gh/openzipkin/zipkin-php-example/tree/master) 4 | 5 | This is an example app where two php services collaborate on an 6 | http request. Notably, timing of these requests are recorded into 7 | Zipkin, a distributed tracing system. 8 | 9 | This allows you to see the how long the whole operation took, as 10 | well how much time was spent in each service. 11 | 12 | zipkin screen shot 13 | 14 | ## Requirements 15 | - [Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx) 16 | - [Docker](https://docs.docker.com/engine/installation/) (optional, if you have a zipkin endpoint this is not needed) 17 | 18 | ## Running the example 19 | 20 | This example has two services: frontend and backend. They both report 21 | trace data to zipkin. 22 | 23 | To setup the demo, do 24 | 25 | ```bash 26 | composer install 27 | ``` 28 | 29 | Once the dependencies are installed, run the services: 30 | 31 | ```bash 32 | # Run zipkin (optional): 33 | composer run-zipkin 34 | 35 | # In terminal 1: 36 | composer run-frontend 37 | 38 | # In terminal 2 39 | composer run-backend 40 | 41 | ``` 42 | 43 | And then, request the frontend: 44 | 45 | ``` 46 | curl http://localhost:8081 47 | ``` 48 | 49 | 1. This starts a trace in the frontend (http://localhost:8081/) 50 | 2. Continues the trace and calls the backend (http://localhost:9000) 51 | 3. Next, you can view traces that went through the backend via http://localhost:9411/?serviceName=frontend. 52 | 53 | 54 | ## Running example with a custom zipkin location: 55 | 56 | If you need to pass the zipkin endpoint, just pass the reporter 57 | url as `HTTP_REPORTER_URL` env variable. 58 | 59 | ```bash 60 | 61 | # In terminal 1: 62 | HTTP_REPORTER_URL=http://myzipkin:9411/api/v2/span composer run-frontend 63 | 64 | # In terminal 2 65 | HTTP_REPORTER_URL=http://myzipkin:9411/api/v2/span composer run-backend 66 | 67 | ``` -------------------------------------------------------------------------------- /appveyor.yml: -------------------------------------------------------------------------------- 1 | build: false 2 | platform: 3 | - x64 4 | clone_folder: c:\projects\zipkin-php-example 5 | 6 | environment: 7 | matrix: 8 | - php_ver_target: 7.4 9 | 10 | init: 11 | - SET COMPOSER_NO_INTERACTION=1 12 | 13 | ## Install PHP and composer, and run the appropriate composer command 14 | install: 15 | - ps: Invoke-WebRequest "https://raw.githubusercontent.com/ChadSikorra/ps-install-php/master/Install-PHP.ps1" -OutFile "Install-PHP.ps1" 16 | - ps: .\Install-PHP.ps1 -Version $Env:php_ver_target -Highest -Arch x64 -Extensions mbstring,intl,openssl,curl 17 | - rm .\Install-PHP.ps1 18 | - refreshenv 19 | - mkdir C:\composer 20 | - cd C:\composer 21 | - php -r "readfile('http://getcomposer.org/installer');" | php 22 | - powershell -command "(Get-Item C:\composer\composer.phar).length" 23 | - powershell -command "'@php C:\composer\composer.phar ' + $([char]37) + '*' | Out-File C:\composer\composer.bat -Encoding ASCII" 24 | - SET PATH=C:\composer;%PATH% 25 | - cd c:\projects\zipkin-php-example 26 | - composer install --no-progress --profile 27 | 28 | ## Run the actual test 29 | test_script: 30 | - cd c:\projects\zipkin-php-example 31 | -------------------------------------------------------------------------------- /backend.php: -------------------------------------------------------------------------------- 1 | headers->all()); 15 | 16 | /* Extracts the context from the HTTP headers */ 17 | $extractor = $tracing->getPropagation()->getExtractor(new Map()); 18 | $extractedContext = $extractor($carrier); 19 | 20 | /* Get users from DB */ 21 | $tracer = $tracing->getTracer(); 22 | $span = $tracer->nextSpan($extractedContext); 23 | $span->start(); 24 | $span->setKind(Zipkin\Kind\SERVER); 25 | $span->setName('parse_request'); 26 | 27 | $childSpan = $tracer->newChild($span->getContext()); 28 | $childSpan->start(); 29 | $childSpan->setKind(Zipkin\Kind\CLIENT); 30 | $childSpan->setName('user:get_list:mysql_query'); 31 | 32 | usleep(50000); 33 | 34 | $childSpan->finish(); 35 | 36 | $span->finish(); 37 | 38 | /* Sends the trace to zipkin once the response is served */ 39 | register_shutdown_function(function () use ($tracer) { 40 | $tracer->flush(); 41 | }); 42 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "openzipkin/zipkin-php-example", 3 | "description": "Example of two services collaborating in a request", 4 | "require": { 5 | "monolog/monolog": "^1.23", 6 | "guzzlehttp/guzzle": "^7.2", 7 | "openzipkin/zipkin": "3.0.0", 8 | "symfony/http-foundation": "3.4.x-dev" 9 | }, 10 | "minimum-stability": "beta", 11 | "authors": [ 12 | { 13 | "name": "José Carlos Chávez", 14 | "email": "jcchavezs@gmail.com" 15 | } 16 | ], 17 | "scripts": { 18 | "run-frontend": "php -S 'localhost:8081' frontend.php", 19 | "run-backend": "php -S 'localhost:9000' backend.php", 20 | "run-zipkin": "docker run -p 9411:9411 -d openzipkin/zipkin" 21 | } 22 | } -------------------------------------------------------------------------------- /frontend.php: -------------------------------------------------------------------------------- 1 | getTracer(); 14 | 15 | /* Always sample traces */ 16 | $defaultSamplingFlags = DefaultSamplingFlags::createAsSampled(); 17 | 18 | /* Creates the main span */ 19 | $span = $tracer->newTrace($defaultSamplingFlags); 20 | $span->start(Timestamp\now()); 21 | $span->setName('parse_request'); 22 | $span->setKind(Zipkin\Kind\SERVER); 23 | 24 | usleep(100 * mt_rand(1, 3)); 25 | 26 | /* Creates the span for getting the users list */ 27 | $childSpan = $tracer->newChild($span->getContext()); 28 | $childSpan->start(); 29 | $childSpan->setKind(Zipkin\Kind\CLIENT); 30 | $childSpan->setName('users:get_list'); 31 | 32 | $headers = []; 33 | 34 | /* Injects the context into the wire */ 35 | $injector = $tracing->getPropagation()->getInjector(new Map()); 36 | $injector($childSpan->getContext(), $headers); 37 | 38 | /* HTTP Request to the backend */ 39 | $httpClient = new Client(); 40 | $request = new \GuzzleHttp\Psr7\Request('POST', 'localhost:9000', $headers); 41 | $childSpan->annotate('request_started', Timestamp\now()); 42 | $response = $httpClient->send($request); 43 | $childSpan->annotate('request_finished', Timestamp\now()); 44 | 45 | $childSpan->finish(); 46 | 47 | $span->finish(); 48 | 49 | /* Sends the trace to zipkin once the response is served */ 50 | 51 | register_shutdown_function(function () use ($tracer) { 52 | $tracer->flush(); 53 | }); 54 | -------------------------------------------------------------------------------- /functions.php: -------------------------------------------------------------------------------- 1 | pushHandler(new \Monolog\Handler\ErrorLogHandler()); 26 | 27 | $reporter = new Zipkin\Reporters\Http(['endpoint_url' => $httpReporterURL]); 28 | $sampler = BinarySampler::createAsAlwaysSample(); 29 | $tracing = TracingBuilder::create() 30 | ->havingLocalEndpoint($endpoint) 31 | ->havingSampler($sampler) 32 | ->havingReporter($reporter) 33 | ->build(); 34 | return $tracing; 35 | } 36 | -------------------------------------------------------------------------------- /screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openzipkin/zipkin-php-example/6694f36769147ea673463dd41c71c9cb265cf61f/screenshot.png --------------------------------------------------------------------------------