github.com/instana/go-sensor@v1.62.2-0.20240520081010-4919868049e1/docs/options.md (about)

     1  ## Options
     2  
     3  #### Service
     4  
     5  **Type:** ``string``
     6  
     7  Service is the global service name that will be used to identify the program in the Instana backend.
     8  
     9  #### AgentHost
    10  
    11  **Type:** ``string``
    12  
    13  AgentHost is the Instana host agent host name.
    14  
    15  #### AgentPort
    16  
    17  **Type:** ``int``
    18  
    19  AgentPort is the Instana host agent port.
    20  
    21  > [!NOTE]
    22  > `AgentHost` and `AgentPort` options have no effect in serverless environments. To specify the serverless acceptor endpoint, define the ``INSTANA_ENDPOINT_URL`` env var.
    23  > See [Serverless Monitoring](https://www.ibm.com/docs/en/instana-observability/current?topic=references-environment-variables#serverless-monitoring) for more details.
    24  
    25  #### MaxBufferedSpans
    26  
    27  **Type:** ``int``
    28  
    29  MaxBufferedSpans is the maximum number of spans to buffer.
    30  
    31  #### ForceTransmissionStartingAt
    32  
    33  **Type:** ``int``
    34  
    35  ForceTransmissionStartingAt is the number of spans to collect before flushing the buffer to the agent.
    36  
    37  #### LogLevel
    38  
    39  **Type:** ``int``
    40  
    41  LogLevel is the initial logging level for the logger used by Instana tracer. 
    42  The valid log levels are logger.{Error,Warn,Info,Debug}Level provided by the https://github.com/instana/go-sensor/logger package.
    43  
    44  > [!NOTE]
    45  > This setting is only used to initialize the default logger and has no effect if a custom logger is set via ``instana.SetLogger()``
    46  
    47  #### EnableAutoProfile
    48  
    49  **Type:** ``bool``
    50  
    51  EnableAutoProfile enables automatic continuous process profiling when set to true.
    52  
    53  #### MaxBufferedProfiles
    54  
    55  **Type:** ``int``
    56  
    57  MaxBufferedProfiles is the maximum number of profiles to buffer.
    58  
    59  #### IncludeProfilerFrames
    60  
    61  **Type:** ``bool``
    62  
    63  IncludeProfilerFrames is whether to include profiler calls into the profile or not.
    64  
    65  #### Tracer
    66  
    67  **Type:** [TracerOptions](https://pkg.go.dev/github.com/instana/go-sensor#TracerOptions)
    68  
    69  Tracer contains tracer-specific configuration used by all tracers
    70  
    71  #### AgentClient
    72  
    73  **Type:** [AgentClient](https://pkg.go.dev/github.com/instana/go-sensor#AgentClient)
    74  
    75  AgentClient client to communicate with the agent. In most cases, there is no need to provide it.
    76  If it is nil the default implementation will be used.
    77  
    78  #### Recorder
    79  **Type:** [SpanRecorder](https://pkg.go.dev/github.com/instana/go-sensor#SpanRecorder)
    80  
    81  Recorder records and manages spans. When this option is not set, instana.NewRecorder() will be used.
    82  
    83  -----
    84  [README](../README.md) |
    85  [Tracing HTTP Outgoing Requests](roundtripper.md) |
    86  [Tracing SQL Driver Databases](sql.md) |
    87  [Tracing Other Go Packages](other_packages.md) |
    88  [Instrumenting Code Manually](manual_instrumentation.md)