Skip to content
This repository was archived by the owner on Oct 3, 2023. It is now read-only.

gRPC plugin : Rename metrics to stats #374

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
*/

import {Stats} from '@opencensus/core';
import {GRPC_BASIC_CLIENT_VIEWS} from './client-metrics';
import {GRPC_BASIC_SERVER_VIEWS} from './server-metrics';
import {GRPC_BASIC_CLIENT_VIEWS} from './client-stats';
import {GRPC_BASIC_SERVER_VIEWS} from './server-stats';

/** Method to register all GRPC Views. */
export function registerAllGrpcViews(globalStats: Stats) {
Expand Down
32 changes: 15 additions & 17 deletions packages/opencensus-instrumentation-grpc/src/grpc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ import {EventEmitter} from 'events';
import * as grpcTypes from 'grpc';
import * as lodash from 'lodash';
import * as shimmer from 'shimmer';
import * as clientMetrics from './grpc-stats/client-metrics';
import * as serverMetrics from './grpc-stats/server-metrics';
import * as clientStats from './grpc-stats/client-stats';
import * as serverStats from './grpc-stats/server-stats';
const sizeof = require('object-sizeof');

/** The metadata key under which span context is stored as a binary value. */
Expand Down Expand Up @@ -232,7 +232,7 @@ export class GrpcPlugin extends BasePlugin {

// record stats
const tags = new TagMap();
tags.set(serverMetrics.GRPC_SERVER_METHOD, {value: rootSpan.name});
tags.set(serverStats.GRPC_SERVER_METHOD, {value: rootSpan.name});
const req = call.hasOwnProperty('request') ? call.request : {};
GrpcPlugin.recordStats(
rootSpan.kind, tags, value, req, Date.now() - startTime);
Expand Down Expand Up @@ -377,7 +377,7 @@ export class GrpcPlugin extends BasePlugin {

// record stats
const tags = new TagMap();
tags.set(clientMetrics.GRPC_CLIENT_METHOD, {value: span.name});
tags.set(clientStats.GRPC_CLIENT_METHOD, {value: span.name});
GrpcPlugin.recordStats(
span.kind, tags, originalArgs, res, Date.now() - startTime);

Expand Down Expand Up @@ -543,45 +543,43 @@ export class GrpcPlugin extends BasePlugin {
switch (kind) {
case SpanKind.CLIENT:
measureList.push({
measure: clientMetrics.GRPC_CLIENT_SENT_BYTES_PER_RPC,
measure: clientStats.GRPC_CLIENT_SENT_BYTES_PER_RPC,
value: sizeof(argsOrValue)
});
measureList.push({
measure: clientMetrics.GRPC_CLIENT_RECEIVED_BYTES_PER_RPC,
measure: clientStats.GRPC_CLIENT_RECEIVED_BYTES_PER_RPC,
value: sizeof(reqOrRes)
});
measureList.push({
measure: clientMetrics.GRPC_CLIENT_RECEIVED_MESSAGES_PER_RPC,
measure: clientStats.GRPC_CLIENT_RECEIVED_MESSAGES_PER_RPC,
value: 1
});
measureList.push({
measure: clientMetrics.GRPC_CLIENT_SENT_MESSAGES_PER_RPC,
measure: clientStats.GRPC_CLIENT_SENT_MESSAGES_PER_RPC,
value: 1
});
measureList.push({
measure: clientMetrics.GRPC_CLIENT_ROUNDTRIP_LATENCY,
value: ms
});
measureList.push(
{measure: clientStats.GRPC_CLIENT_ROUNDTRIP_LATENCY, value: ms});
break;
case SpanKind.SERVER:
measureList.push({
measure: serverMetrics.GRPC_SERVER_RECEIVED_BYTES_PER_RPC,
measure: serverStats.GRPC_SERVER_RECEIVED_BYTES_PER_RPC,
value: sizeof(reqOrRes)
});
measureList.push({
measure: serverMetrics.GRPC_SERVER_RECEIVED_MESSAGES_PER_RPC,
measure: serverStats.GRPC_SERVER_RECEIVED_MESSAGES_PER_RPC,
value: 1
});
measureList.push({
measure: serverMetrics.GRPC_SERVER_SENT_BYTES_PER_RPC,
measure: serverStats.GRPC_SERVER_SENT_BYTES_PER_RPC,
value: sizeof(argsOrValue)
});
measureList.push({
measure: serverMetrics.GRPC_SERVER_SENT_MESSAGES_PER_RPC,
measure: serverStats.GRPC_SERVER_SENT_MESSAGES_PER_RPC,
value: 1
});
measureList.push(
{measure: serverMetrics.GRPC_SERVER_SERVER_LATENCY, value: ms});
{measure: serverStats.GRPC_SERVER_SERVER_LATENCY, value: ms});
break;
default:
break;
Expand Down
34 changes: 16 additions & 18 deletions packages/opencensus-instrumentation-grpc/test/test-grpc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ import * as assert from 'assert';
import * as grpcModule from 'grpc';
import * as path from 'path';
import {GRPC_TRACE_KEY, GrpcModule, GrpcPlugin, plugin, SendUnaryDataCallback} from '../src/';
import * as clientMetrics from '../src/grpc-stats/client-metrics';
import * as serverMetrics from '../src/grpc-stats/server-metrics';
import * as clientStats from '../src/grpc-stats/client-stats';
import * as serverStats from '../src/grpc-stats/server-stats';
import {registerAllGrpcViews} from '../src/grpc-stats/stats-common';

const PROTO_PATH = __dirname + '/fixtures/grpc-instrumentation-test.proto';
Expand Down Expand Up @@ -373,41 +373,39 @@ describe('GrpcPlugin() ', function() {
assert.equal(testExporter.recordedMeasurements.length, 10);
assert.strictEqual(
testExporter.recordedMeasurements[0].measure,
serverMetrics.GRPC_SERVER_RECEIVED_BYTES_PER_RPC);
serverStats.GRPC_SERVER_RECEIVED_BYTES_PER_RPC);
assert.equal(testExporter.recordedMeasurements[0].value, 14);
assert.deepStrictEqual(testExporter.recordedMeasurements[1], {
measure: serverMetrics.GRPC_SERVER_RECEIVED_MESSAGES_PER_RPC,
value: 1
});
assert.deepStrictEqual(
testExporter.recordedMeasurements[1],
{measure: serverStats.GRPC_SERVER_RECEIVED_MESSAGES_PER_RPC, value: 1});
assert.strictEqual(
testExporter.recordedMeasurements[2].measure,
serverMetrics.GRPC_SERVER_SENT_BYTES_PER_RPC);
serverStats.GRPC_SERVER_SENT_BYTES_PER_RPC);
assert.equal(testExporter.recordedMeasurements[2].value, 14);
assert.deepStrictEqual(
testExporter.recordedMeasurements[3],
{measure: serverMetrics.GRPC_SERVER_SENT_MESSAGES_PER_RPC, value: 1});
{measure: serverStats.GRPC_SERVER_SENT_MESSAGES_PER_RPC, value: 1});
assert.strictEqual(
testExporter.recordedMeasurements[4].measure,
serverMetrics.GRPC_SERVER_SERVER_LATENCY);
serverStats.GRPC_SERVER_SERVER_LATENCY);

assert.strictEqual(
testExporter.recordedMeasurements[5].measure,
clientMetrics.GRPC_CLIENT_SENT_BYTES_PER_RPC);
clientStats.GRPC_CLIENT_SENT_BYTES_PER_RPC);
assert.equal(testExporter.recordedMeasurements[5].value, 107);
assert.strictEqual(
testExporter.recordedMeasurements[6].measure,
clientMetrics.GRPC_CLIENT_RECEIVED_BYTES_PER_RPC);
clientStats.GRPC_CLIENT_RECEIVED_BYTES_PER_RPC);
assert.equal(testExporter.recordedMeasurements[6].value, 14);
assert.deepStrictEqual(testExporter.recordedMeasurements[7], {
measure: clientMetrics.GRPC_CLIENT_RECEIVED_MESSAGES_PER_RPC,
value: 1
});
assert.deepStrictEqual(
testExporter.recordedMeasurements[7],
{measure: clientStats.GRPC_CLIENT_RECEIVED_MESSAGES_PER_RPC, value: 1});
assert.deepStrictEqual(
testExporter.recordedMeasurements[8],
{measure: clientMetrics.GRPC_CLIENT_SENT_MESSAGES_PER_RPC, value: 1});
{measure: clientStats.GRPC_CLIENT_SENT_MESSAGES_PER_RPC, value: 1});
assert.strictEqual(
testExporter.recordedMeasurements[9].measure,
clientMetrics.GRPC_CLIENT_ROUNDTRIP_LATENCY);
clientStats.GRPC_CLIENT_ROUNDTRIP_LATENCY);
assert.ok(testExporter.recordedMeasurements[9].value > 0);
}

Expand Down