docs

Init context

open( filePath, [mode] )

k6

check( val, sets, [tags] )
fail( [err] )
group( name, fn )
randomSeed( int )
sleep( t )

k6/crypto

createHash( algorithm )
createHMAC( algorithm, secret )
hmac( algorithm, secret, data, outputEncoding )
md4( input, outputEncoding )
md5( input, outputEncoding )
randomBytes( int )
ripemd160( input, outputEncoding )
sha1( input, outputEncoding )
sha256( input, outputEncoding )
sha384( input, outputEncoding )
sha512( input, outputEncoding )
sha512_256( input, outputEncoding )
sha512_224( input, outputEncoding )
Hasher

k6/data

SharedArray

k6/encoding

b64decode( input, [encoding], [format] )
b64encode( input, [encoding] )

k6/execution

k6/experimental

browser
grpc
redis
timers
tracing
websockets
webcrypto

k6/html

parseHTML( src )
Element
Selection

k6/http

asyncRequest( method, url, [body], [params] )
batch( requests )
cookieJar()
del( url, [body], [params] )
file( data, [filename], [contentType] )
get( url, [params] )
head( url, [params] )
options( url, [body], [params] )
patch( url, [body], [params] )
post( url, [body], [params] )
put( url, [body], [params] )
request( method, url, [body], [params] )
setResponseCallback( callback )
url`url`
expectedStatuses( statuses )
CookieJar
FileData
Params
Response

k6/metrics

Counter
Gauge
Rate
Trend

k6/net/grpc

Client
Params
Response
Constants

k6/ws

connect( url, params, callback )
Params
Socket

Error Codes

k6.ioapp.k6.io

No results for “”

Powered byAlgolia
⚠️ This documentation is outdated. Please visit grafana.com for the latest k6 documentation.📚

Client.connect(address [,params])

suggest edits

Opens a connection to a gRPC server; will block until a connection is made or a connection error is thrown. Cannot be called during the init phase.

See Client.close() to close the connection.

ParameterTypeDescription
addressstringThe address of the gRPC server. Should be in the form: host:port with no protocol prefix e.g. grpc.k6.io:443. The host must be a literal IP address, or a host name that can be resolved to IP addresses. The port must be a literal port number or a service name e.g. :443 or :https. If the host is a literal IPv6 address it must be enclosed in square brackets, as in [2001:db8::1]:80 or [fe80::1%zone]:80.
params (optional)objectConnectParams object containing additional connect parameters.

ConnectParams

NameTypeDescription
ConnectParams.plaintextboolIf true will connect to the gRPC server using plaintext i.e. insecure. Defaults to false i.e. secure via TLS.
ConnectParams.reflectbooleanWhether to use the gRPC server reflection protocol when connecting.
ConnectParams.timeoutstring / numberConnection timeout to use. Default timeout is "60s".
The type can also be a number, in which case k6 interprets it as milliseconds, e.g., 60000 is equivalent to "60s".
ConnectParams.maxReceiveSizenumberSets the maximum message size in bytes the client can receive.Defaults to 0.
ConnectParams.maxSendSizenumberSets the maximum message size in bytes the client can send.Defaults to 0.

Examples

import grpc from 'k6/experimental/grpc';


const client = new grpc.Client();


export default () => {
  client.connect('localhost:8080');
};
import grpc from 'k6/experimental/grpc';


const client = new grpc.Client();


export default () => {
  client.connect('localhost:8080', { plaintext: true });
};