Instrument Go セグメント

New Relic for Go を使用すると、Go アプリケーションのトランザクションの特定のセグメントを監視して、特定の機能やコードブロックについてより詳細な情報を得ることができます。

機能やコードブロックの計測時間

Segments アプリケーション内のトランザクションの特定の部分です。インストゥルメントされたセグメントによって、外部呼び出し、データストア呼び出し、キューへのメッセージの追加、バックグラウンドタスクなどの関数とコードブロックにかかる時間を測定できます。

Example: 配送情報とクレジットカード情報の両方を処理するチェックアウトプロセスに関連付けられたトランザクションがあります。アプリケーションを計量して、その現場を 2 つの部分、つまり配送用の 1 つのセグメントと支払い用の 1 つのセグメントに分割することができます。

ブロック・オブ・コード・セグメント

トランザクションをインストルメントすると、そのトランザクション内の1つまたは複数のセグメントをインストルメントする準備が整います。

コードの任意のブロックをセグメントとして計測するには、次のパターンを使用し、トランザクションに設定された変数名としてtxnを含めます。

segment := newrelic.Segment{}
segment.Name = "mySegmentName"
segment.StartTime = txn.StartSegmentNow()
// ... code you want to time here ...
segment.End()

StartSegment 便利なヘルパーです。セグメントを作成して開始します。

segment := txn.StartSegment("mySegmentName")
// ... code you want to time here ...
segment.End()

機能セグメント

関数をセグメントとしてインスツルメントすることは、任意のコードブロックをセグメントとしてインスツルメントすることと基本的に同じです。主な違いは、関数には個別の終わりがあるので、Go の defer ステートメントを使用できることです。

関数をセグメントとして計測するには、関数の先頭に次のコードを追加し、トランザクションに設定された変数名としてtxnを含めます。

defer txn.StartSegment("mySegmentName").End()

ネストセグメント

セグメントはネストすることができます。終了するセグメントは、最後に開始されたセグメントでなければなりません。

以下は、あるセグメントが別のセグメントの中で始まり、終わる例です。

s1 := txn.StartSegment("outerSegment")
s2 := txn.StartSegment("innerSegment")
// s2 must end before s1
s2.End()
s1.End()

ゼロ値のセグメントは安全に終了することができます。したがって、次のコードは、条件付きで失敗しても安全です。

var s newrelic.Segment
if recordSegment {
    s.StartTime = txn.StartSegmentNow()
}
// ... code you wish to time here ...
s.End()

データストアのセグメント

Go アプリケーションデータストアの通話を計装できます。データストアセグメントは、New Relic のTransactionsページの APM Transactions breakdownテーブルとDatabasesタブに表示されます。

MySQL、PostgreSQL、または SQLite データベースドライバを使用している場合、Datastore セグメントを追加する最も簡単な方法は、あらかじめ組み込まれている統合パッケージを使用することです。それ以外の場合は、データベースを呼び出すたびに手動で Datastore セグメントを作成することができます。

サポートしているデータベースドライバごとに統合パッケージを用意しています。

対応データベースライブラリ	インテグレーションパッケージ
go-sql-driver/mysql	v3/integrations/nrmysql
lib/pq	v3/integrations/nrpq
mattn/go-sqlite3	v3/integrations/nrsqlite3

これらの統合機能を使用するには、まずドライバーを当社の統合バージョンに置き換えてください。

import (
    // import our integration package in place of "github.com/go-sql-driver/mysql"
    _ "github.com/newrelic/go-agent/v3/integrations/nrmysql"
)

func main() {
    // open "nrmysql" in place of "mysql"
    db, err := sql.Open("nrmysql", "user@unix(/path/to/socket)/dbname")
}

次に、 sql.DB 、 sql.Conn 、 sql.Tx 、およびsql.StmtのExecContext 、 QueryContext 、およびQueryRowContextメソッドを使用して、トランザクションを含むコンテキストを提供します。Exec 、 Query 、およびQueryRowへの呼び出しは計測されません。

ctx := newrelic.NewContext(context.Background(), txn)
row := db.QueryRowContext(ctx, "SELECT count(*) from tables")

上記以外の database/sql データベースを使用している場合は、 InstrumentConnector 、 InstrumentDriver 、 DriverSegmentBuilder を使用して、独自のインスツルメンテーションを記述することができます。統合パッケージは、この方法の例として機能します。

重要

MySQL、PostgreSQL、および SQLite のデータストア統合パッケージは、Go エージェント v2.8.0 で追加され、Go v1.10 以降が必要です。

基本セグメントと同様に、データストアセグメントは、 StartTimeフィールドにデータが入力されると開始し、 Endメソッドが呼び出されると終了します。データストアセグメントを計測するには、監視する関数の先頭に次を配置します。

s := newrelic.DatastoreSegment{
    Product: newrelic.DatastoreMySQL,
    Collection: "users",
    Operation: "INSERT",
    ParameterizedQuery: "INSERT INTO users (name, age) VALUES ($1, $2)",
    QueryParameters: map[string]interface{}{
        "name": "Dracula",
        "age": 439,
    },
    Host: "mysql-server-1",
    PortPathOrID: "3306",
    DatabaseName: "my_database",
}
s.StartTime = txn.StartSegmentNow()
// ... make the datastore call
s.End()

については、こちらをご覧ください。

Collection 、 Operation 、 DatabaseName 、およびその他のパラメーター値の割り当て: GoDoc の New Relic データストアセグメントのドキュメントを参照してください。
Productに使用できる値: GitHub の New Relic ドキュメントを参照してください。

関数呼び出し全体に渡るデータストア呼び出しをインストゥルメンテーションする場合、defer文を使用してインストゥルメンテーションを簡素化することができます。

s := newrelic.DatastoreSegment{
    StartTime: txn.StartSegmentNow(),
    Product: newrelic.DatastoreMySQL,
    Collection: "users",
    Operation: "INSERT",
    ParameterizedQuery: "INSERT INTO users (name, age) VALUES ($1, $2)",
    QueryParameters: map[string]interface{}{
        "name": "Dracula",
        "age": 439,
    },
    Host: "mysql-server-1",
    PortPathOrID: "3306",
    DatabaseName: "my_database",
}
defer s.End()

外部セグメント

Web サービス、クラウド内のリソース、その他のネットワーク呼び出しなどの外部サービスへの Go アプリケーション呼び出しを計装できます。外部セグメントは、New Relic の Transactions breakdownテーブルとExternal servicesページに表示されます。

外部セグメントのインストルメントには2つの方法があります。

Recommendation: New Relicディストリビューティッド（分散）トレーシングを使用してアプリケーション間のアクティビティをトレースするために StartExternalSegment ヘルパーを使用するため、ヘルパーを使用します。

func external(txn *newrelic.Transaction, req *http.Request) (*http.Response, error) {
    s := newrelic.StartExternalSegment(txn, req)
    response, err := http.DefaultClient.Do(req)
    s.Response = response
    s.End()
    return response, err
}

NewRoundTripper http.RoundTripperを返します。これにより、 http.ClientのTransportフィールドを変更することで、 StartExternalSegmentを呼び出さずに外部呼び出しを計測できます。返されたRoundTripperは、 FromContextを使用してリクエストのコンテキストでTransactionを探します。

NewRoundTripperインストルメンテーションの例を次に示します。

client := &http.Client{}
client.Transport = newrelic.NewRoundTripper(client.Transport)

request, _ := http.NewRequest("GET", "http://example.com", nil)
request = newrelic.RequestWithTransactionContext(request, txn)

response, err := client.Do(request)

メッセージ・プロデューサー・セグメント

RabbitMQ や Kafka などのキューイングシステムにメッセージを追加する Go アプリケーション呼び出しを計算できます。メッセージプロデューサーセグメントは、New Relic の APM Transactions breakdownに表示されます。

メッセージ・プロデューサー・セグメントを計測する方法は一つしかありません。

基本セグメントと同様に、メッセージプロデューサセグメントは、 StartTimeフィールドにデータが入力されると開始し、 Endメソッドが呼び出されると終了します。メッセージプロデューサセグメントをインストルメント化するには、監視する関数の先頭に以下を配置します。

s := newrelic.MessageProducerSegment{
    Library:              "RabbitMQ",
    DestinationType:      newrelic.MessageExchange,
    DestinationName:      "myExchange",
    DestinationTemporary: false,
}
s.StartTime = txn.StartSegmentNow()
// ... add message to queue
s.End()

Library 、 DestinationType 、 DestinationName 、またはDestinationTemporaryフィールドの割り当ての詳細については、GoDoc の New Relic メッセージプロデューサーセグメントのドキュメントを参照してください。

関数呼び出し全体にまたがるメッセージ・プロデューサー・コールをインスツルメンテーションする場合、deferステートメントを使用してインスツルメンテーションを簡素化することができます。

s := newrelic.MessageProducerSegment{
    StartTime:            txn.StartSegmentNow(),
    Library:              "RabbitMQ",
    DestinationType:      newrelic.MessageExchange,
    DestinationName:      "myExchange",
    DestinationTemporary: false,
}
defer s.End()
// ... add message to queue

重要

メッセージプロデューサーセグメントは、Go エージェントバージョン 2.14.0 で追加されました。

この機械翻訳は、参考として提供されています。

機能やコードブロックの計測時間

ブロック・オブ・コード・セグメント

機能セグメント

ネストセグメント

データストアのセグメント

計装パッケージの使用

重要

使用する `DatastoreSegment`

外部セグメント

使用する `StartExternalSegment()`

使用する `NewRoundTripper()`

メッセージ・プロデューサー・セグメント

使用する `MessageProducerSegment`

重要

この機械翻訳は、参考として提供されています。

Instrument Go セグメント

機能やコードブロックの計測時間 .css-21sua1{background:none;border:none;width:0;padding:0;}

ブロック・オブ・コード・セグメント

機能セグメント

ネストセグメント

データストアのセグメント

使用する DatastoreSegment

外部セグメント

使用する StartExternalSegment()

使用する NewRoundTripper()

メッセージ・プロデューサー・セグメント

使用する MessageProducerSegment

機能やコードブロックの計測時間

使用する `DatastoreSegment`

使用する `StartExternalSegment()`

使用する `NewRoundTripper()`

使用する `MessageProducerSegment`