skywalking-go
The Golang auto-instrument Agent for Apache SkyWalking, which provides the native tracing/metrics/logging abilities for Golang projects.
File Explorer
Download Latest Version (.zip)- e2e.yaml
- plugin-tests.yaml
- publish-docker.yaml
- skywalking-go.yaml
- windows-plugin-test.yaml
- compile.go
- compile.go
- compile.go
- compile.go
- compile.go
- imports.go
- license-github.com-benbjohnson-clock.txt
- license-github.com-dave-dst.txt
- license-github.com-dave-jennifer.txt
- license-github.com-davecgh-go-spew.txt
- license-github.com-kr-pretty.txt
- license-github.com-kr-text.txt
- license-github.com-pkg-errors.txt
- license-github.com-pmezard-go-difflib.txt
- license-github.com-rogpeppe-go-internal.txt
- license-github.com-sergi-go-diff.txt
- license-github.com-sirupsen-logrus.txt
- license-github.com-stretchr-objx.txt
- license-github.com-stretchr-testify.txt
- license-go.uber.org-atomic.txt
- license-go.uber.org-goleak.txt
- license-go.uber.org-multierr.txt
- license-go.uber.org-zap.txt
- license-golang.org-x-mod.txt
- license-golang.org-x-sync.txt
- license-golang.org-x-sys.txt
- license-golang.org-x-text.txt
- license-golang.org-x-tools.txt
- license-gopkg.in-check.v1.txt
- license-gopkg.in-yaml.v3.txt
- LICENSE
- NOTICE
- toolkit-log.md
- toolkit-metric.md
- toolkit-trace.md
- grpc-tls.md
- kafka-reporter.md
- logging-setup.md
- plugin-exclusion.md
- settings-override.md
- performance-tests.md
- plugin-configurations.md
- support-plugins.md
- tracing-metrics-logging.md
- hybrid-compilation.md
- key-principles.md
- project-structure.md
- build-and-use-agent.md
- development-guide.md
- how-to-release.md
- running-and-debugging.md
- write-plugin-testing.md
- docker.md
- gobuild.md
- menu.yml
- README.md
- logger.go
- consumer.go
- dial_hook.go
- general_consumer.go
- general_consumer_test.go
- go.mod
- go.sum
- instrument.go
- producer.go
- structures.go
- declare.go
- enhance.go
- method.go
- method_test.go
- struct.go
- struct_test.go
- logger.go
- bridge.go
- metrics.go
- common.go
- intercepter.go
- intercepter_test_base.go
- invocation.go
- logger.go
- metrics.go
- profiler.go
- so11y.go
- tools.go
- tracing.go
- api.go
- grpc.go
- grpc_opts_enhance.go
- send_tracing_recover_test.go
- kafka.go
- kafka_opts_enhance.go
- send_tracing_recover_test.go
- api.go
- cds_manager.go
- config_discovery.go
- conn_manager.go
- discard_reporter.go
- discard_reporter_test.go
- pprof_manager.go
- profile.go
- transform.go
- os.go
- reflect.go
- reflect_bridge.go
- strconv.go
- sync.go
- api.go
- bridge.go
- context.go
- postgres_peer.go
- postgres_peer_test.go
- span.go
- sql_runtime_context.go
- context.go
- correlation.go
- fs.go
- go.mod
- go.sum
- id.go
- id_test.go
- logreport.go
- logreport_test.go
- metrics.go
- pprof.go
- prof_labels.go
- prof_labels_test.go
- profile.go
- profile_event_manager.go
- profile_event_manager_test.go
- profile_writer.go
- propagating.go
- propagation_test.go
- sampler.go
- sampler_test.go
- segment_datarace_test.go
- so11y.go
- span.go
- span_crash_e2e_test.go
- span_default.go
- span_freeze_test.go
- span_hostile_workload_test.go
- span_noop.go
- span_reuse_test.go
- span_sync_bench_test.go
- span_tracing.go
- test_base.go
- tool.go
- trace_profiling_event_manager.go
- tracer.go
- tracer_ignore.go
- tracer_ignore_test.go
- tracer_test.go
- tracer_tools.go
- tracer_tools_test.go
- tracing.go
- tracing_extract_test.go
- tracing_test.go
- client_intercepter.go
- server_intercepter.go
- go.mod
- go.sum
- instrument.go
- go.mod
- go.sum
- instrument.go
- intercepter.go
- client_intercepter.go
- client_intercepter_test.go
- instrument.go
- instrument.go
- server_intercepter.go
- server_intercepter_test.go
- go.mod
- go.sum
- go.mod
- go.sum
- instrument.go
- intercepter.go
- config.go
- go.mod
- go.sum
- instrument.go
- intercepter.go
- intercepter_test.go
- structures.go
- go.mod
- go.sum
- instrument.go
- intercepter.go
- config.go
- go.mod
- go.sum
- hook.go
- instrument.go
- intercepter.go
- op_type.go
- add_filter.go
- filter.go
- filter_test.go
- go.mod
- go.sum
- instrument.go
- config.go
- intercepter.go
- intercepter_test.go
- go.mod
- go.sum
- instrument.go
- callback.go
- callback_test.go
- config.go
- database.go
- instrument.go
- interceptor.go
- interceptor_test.go
- instrument.go
- interceptor.go
- interceptor_test.go
- instrument.go
- interceptor.go
- interceptor_test.go
- go.mod
- go.sum
- client_closesend_interceptor.go
- client_finish_interceptor.go
- client_finish_interceptor_test.go
- client_recvmsg_interceptor.go
- client_sendmsg_interceptor.go
- client_streaming_interceptor.go
- client_unary_interceptor.go
- constants.go
- formatOperationName.go
- go.mod
- go.sum
- instrument.go
- server_handleStream_interceptor.go
- server_handleStream_interceptor_test.go
- server_recvmsg_interceptor.go
- server_sendmsg_interceptor.go
- server_sendresponse_interceptor.go
- server_streaming_interceptor.go
- server_unary_interceptor.go
- structures.go
- client_intercepter.go
- client_intercepter_test.go
- config.go
- go.mod
- go.sum
- instrument.go
- server_intercepter.go
- server_intercepter_test.go
- intercepter.go
- go.mod
- go.sum
- instrument.go
- client.go
- server.go
- server_middleware.go
- server_test.go
- client.go
- client_middleware.go
- server.go
- server_middleware.go
- server_test.go
- structures.go
- go.mod
- go.sum
- instrument.go
- client.go
- next_interceptor.go
- server.go
- structure.go
- accept_interceptor.go
- close_interceptor.go
- close_interceptor_test.go
- go.mod
- go.sum
- instrument.go
- interceptor.go
- references.go
- config.go
- interceptor.go
- interceptor_test.go
- go.mod
- go.sum
- instrument.go
- go.mod
- go.sum
- instrument.go
- match_interceptor.go
- serve_interceptor.go
- serve_interceptor_test.go
- structures.go
- go.mod
- instrument.go
- intercepter.go
- receive_consumer.go
- send_async_producer.go
- send_async_producer_test.go
- send_producer.go
- structures.go
- go.mod
- go.sum
- instrument.go
- consumer.go
- consumer_status.go
- consumer_test.go
- structures.go
- async_producer.go
- async_producer_test.go
- general_producer.go
- send_one_way.go
- send_status.go
- structures.go
- sync_producer.go
- go.mod
- go.sum
- instrument.go
- go.mod
- go.sum
- instrument.go
- registers.go
- go.mod
- go.sum
- instrument.go
- reader_interceptor.go
- writer_interceptor.go
- config.go
- conn_begin_tx.go
- conn_exec.go
- conn_ping.go
- conn_prepare.go
- conn_query.go
- conn_raw.go
- db_begin_tx.go
- db_conn.go
- db_exec.go
- db_ping.go
- db_prepare.go
- db_query.go
- general.go
- instance_open.go
- instrument.go
- span.go
- stmt_exec.go
- stmt_query.go
- tx_commit.go
- tx_exec.go
- tx_prepare.go
- tx_query.go
- tx_rollback.go
- tx_stmt.go
- instrument.go
- parse_interceptor.go
- instrument.go
- interceptor.go
- interceptor_test.go
- go.mod
- go.sum
- debug_entry_intercepter.go
- error_entry_intercepter.go
- info_entry_intercepter.go
- send_entry.go
- warn_entry_intercepter.go
- counter_get_intercepter.go
- counter_inc_intercepter.go
- gauge_get_intercepter.go
- histogram_observe_intercepter.go
- histogram_observewithcount_intercepter.go
- meter_opt_intercepter.go
- new_counter_intercepter.go
- new_gauge_intercepter.go
- new_histogram_intercepter.go
- add_event_intercepter.go
- add_log_intercepter.go
- async_add_event_intercepter.go
- async_finish_intercepter.go
- async_log_intercepter.go
- async_prepare_intercepter.go
- async_tag_intercepter.go
- capture_intercepter.go
- consts.go
- continue_intercepter.go
- correlation_get_intercepter.go
- correlation_set_intercepter.go
- create_entryspan_intercepter.go
- create_exitspan_intercepter.go
- create_localspan_intercepter.go
- error_intercepter.go
- get_segmentid_intercepter.go
- get_spanid_intercepter.go
- get_traceid_intercepter.go
- set_component_interceptor.go
- set_name_intercepter.go
- set_tag_intercepter.go
- span_ref_intercepter.go
- stopspan_intercepter.go
- go.mod
- go.sum
- instrument.go
- ConfigurationDiscoveryService.pb.go
- ConfigurationDiscoveryService_grpc.pb.go
- Command.pb.go
- Common.pb.go
- accesslog.pb.go
- accesslog_grpc.pb.go
- Process.pb.go
- Process_grpc.pb.go
- Continuous.pb.go
- Continuous_grpc.pb.go
- Profile.pb.go
- Profile_grpc.pb.go
- Event.pb.go
- Event_grpc.pb.go
- BrowserPerfCompat.pb.go
- BrowserPerfCompat_grpc.pb.go
- CLRMetricCompat.pb.go
- CLRMetricCompat_grpc.pb.go
- JVMMetricCompat.pb.go
- JVMMetricCompat_grpc.pb.go
- MeterCompat.pb.go
- MeterCompat_grpc.pb.go
- TracingCompat.pb.go
- TracingCompat_grpc.pb.go
- BrowserPerf.pb.go
- BrowserPerf_grpc.pb.go
- CLRMetric.pb.go
- CLRMetric_grpc.pb.go
- JVMMetric.pb.go
- JVMMetric_grpc.pb.go
- Meter.pb.go
- Meter_grpc.pb.go
- Tracing.pb.go
- Tracing_grpc.pb.go
- AsyncProfiler.pb.go
- AsyncProfiler_grpc.pb.go
- ProfileCompat.pb.go
- ProfileCompat_grpc.pb.go
- Profile.pb.go
- Profile_grpc.pb.go
- Logging.pb.go
- Logging_grpc.pb.go
- ManagementCompat.pb.go
- ManagementCompat_grpc.pb.go
- Management.pb.go
- Management_grpc.pb.go
- Pprof.pb.go
- Pprof_grpc.pb.go
- service-mesh.pb.go
- service-mesh_grpc.pb.go
- go.mod
- go.sum
- main.go
- go.mod
- go.sum
- main.go
- Dockerfile
- go.mod
- main.go
- Dockerfile
- go.mod
- main.go
- docker-compose.yml
- logs-list.yml
- metrics-has-value.yml
- service-endpoint-consumer.yml
- service-endpoint-provider.yml
- service-instance-consumer.yml
- service-instance-provider.yml
- service.yml
- trace-info-detail.yml
- trace-users-detail.yml
- traces-list-consumer.yml
- traces-list-provider.yml
- docker-compose.yml
- e2e.yaml
- docker-compose.yml
- e2e.yaml
- base-compose.yml
- install-swctl.sh
- install-yq.sh
- install.sh
- log4j2.xml
- env
- Makefile
- docker-compose.tpl
- dockerfile.tpl
- render.go
- scenarios.tpl
- validator.tpl
- windows-docker-compose.tpl
- windows-scenarios.tpl
- windows-validator.tpl
- wsl-scenarios.tpl
- context.go
- go.mod
- go.sum
- main.go
- main_test.go
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- api.proto
- startup.sh
- excepted.yml
- client.go
- dubbogo.yaml
- server.go
- dubbogo.yaml
- go.mod
- go.sum
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- elasticsearch.yml
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted-gorm-v1.25.10.yml
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted-gorm-v1.25.10.yml
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- api.proto
- startup.sh
- excepted.yml
- client.go
- server.go
- go.mod
- go.sum
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- main.go
- plugin.yml
- test_service.go
- startup.sh
- excepted.yml
- client.go
- go.mod
- go.sum
- plugin.yml
- server.go
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- broker.conf
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- startup.sh
- excepted.yml
- go.mod
- main.go
- plugin.yml
- test_service.go
- startup.sh
- excepted.yml
- go.mod
- go.sum
- main.go
- plugin.yml
- Dockerfile
- Makefile
- run.sh
- api.go
- api.go
- metrics.go
- api.go
- span.go
- go.mod
- test.go
- test.go
- test.go
- helper.go
- injector.go
- injector_test.go
- main.go
- agent.yaml
- agent.default.yaml
- loader.go
- loader_test.go
- instrument.go
- flags.go
- instrument.go
- directive.go
- operator.go
- platform.go
- reporter.go
- tls.go
- instrument.go
- automatic_bind.tmpl
- init.tmpl
- api.go
- logrus.go
- logrus_adapt.go
- logrus_format.go
- zap.go
- zap_core.go
- zap_root.go
- context.go
- instrument.go
- context.go
- func.go
- import.go
- rewrite.go
- type.go
- var.go
- method_inserts.tmpl
- method_intercept_after.tmpl
- method_intercept_before.tmpl
- enhance_config.go
- enhance_instance.go
- enhance_method.go
- instrument.go
- instrument_test.go
- register.go
- instrument.go
- instrument.go
- instrument.go
- multi-modules.txt
- no-modules.txt
- single-modules.txt
- special-modules.txt
- wrong-modules.txt
- copy.go
- directive.go
- directive_test.go
- dst.go
- dst_test.go
- enhancement.go
- enhancement_test.go
- files.go
- flags.go
- logger.go
- templetes.go
- types.go
- vendor.go
- vendor_test.go
- go.mod
- go.sum
- Makefile
- generate.sh
- skywalking-data-collect-protocol
- create_bin_release.sh
- create_source_release.sh
- tls_key_generate.sh
- .asf.yaml
- .gitignore
- .gitmodules
- .golangci.yml
- .licenserc.yaml
- api.go
- CHANGES.md
- Dockerfile
- go.mod
- go.sum
- go.work
- go.work.sum
- imports.go
- LICENSE
- Makefile
- NOTICE
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/apache/skywalking-go
Downloads the entire project code from GitHub to your computer.
cd skywalking-go
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t skywalking-go .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 skywalking-go
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Go
MediumPrerequisites
go build ./...
Compiles the Go program into an executable.
go run .
Runs the Go program directly without a separate build step.
If the build finishes without errors, it worked. If you used go run ., check the terminal output.
4. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)